FOnline2238.cfg

Revision as of 22:04, 28 November 2012 (view source) Wipe (Talk | contribs) m (→‎Timeouts: follow the naming scheme) ← Older edit		Revision as of 02:55, 12 December 2012 (view source) Wipe (Talk | contribs) (incoming changes) Newer edit →
Line 1:		Line 1:
		+	{{WIP}}
		+
	== Intro ==		== Intro ==
Line 156:		Line 158:
	''ScreenshotName=screenshots\%CHARNAME%\%YEAR%-%MONTH%-%DAY%_%HOUR%-%MINUTE%-%SECOND%.png''		''ScreenshotName=screenshots\%CHARNAME%\%YEAR%-%MONTH%-%DAY%_%HOUR%-%MINUTE%-%SECOND%.png''
−
−	=== VerboseActionHead ===
−
−	Displays message above character, when (s)he uses specifing items/skills on self or other critters.
−
−	{{ConfigurationVar|type=boolean|default=on}}
−
−	=== VerboseActionBox ===
−
−	Displays information in messagebox, when given character uses specifing items/skills on self or other critters.
−
−	{{ConfigurationVar|type=boolean|default=off}}
	== Section: DataFiles ==		== Section: DataFiles ==
Line 187:		Line 177:
	'''Note:''' See also [[Game Files]]		'''Note:''' See also [[Game Files]]
−	== Section: Timeouts ==	+	== Section: Messages ==
−	blah	+	Contains settings for various messages, which shows up for short time around character's head.
		+
		+	----
		+
		+	=== ActionVisible ===
		+
		+	Allows to turn on/off messages displayed when character uses specific items/skills on self or other critters.
		+
		+	{{ConfigurationVar|type=visibility|default=head}}
		+
		+	=== ActionOffsetX ===
		+
		+	Horizontal position of message displayed when character uses specific items/skills on self or other critters. Final value is picked randomly from range specified.
		+
		+	{{ConfigurationVar|type=range|info=signed|default=-15 15}}
		+
		+	=== ActionOffsetY ===
		+
		+	Vertical position of message displayed when character uses specific items/skills on self or other critters. Final value is picked randomly from range specified.
		+
		+	{{ConfigurationVar|type=range|info=signed|default=-20}}
		+
		+	=== ActionColor ===
		+
		+	Color of message displayed when character uses specific items/skills on self or other critters. Final value is picked randomly from range specified.
		+
		+	{{ConfigurationVar|type=color|default=58 137 133}}
		+
		+	=== DamageOffsetX ===
		+
		+	Horizontal position of message with damage done to character. Final value is picked randomly from range specified.
		+
		+	{{ConfigurationVar|type=range|info=signed|default=-15 15}}
		+
		+	=== DamageOffsetY ===
		+
		+	Vertical position of message with damage done to character. Final value is picked randomly from range specified.
		+
		+	{{ConfigurationVar|type=range|info=signed|default=-20}}
		+
		+	=== DamageColor ===
		+
		+	Color of message with damage done to character.
		+
		+	{{ConfigurationVar|type=color|default=200 0 0}}
		+
		+	=== FollowerExperience ===
		+
		+	Displays followers experience/level changes (above head only).
		+
		+	'''NOTE''': This message is visible only to follower master.
		+
		+	{{ConfigurationVar|type=boolean|default=false}}
		+
		+	== Section: Timeouts ==
	----		----

---

Revision as of 02:55, 12 December 2012

Contents 1 Intro 1.1 Details 2 Section: 2238 2.1 Autosave 2.2 Awareness 2.3 CombatMode 2.4 CustomIni 2.5 DisplayNames 2.6 DisplayTC 2.7 DisplayTCZones 2.8 Fog 2.9 FogColor 2.10 IgnoreLangChange 2.11 LogfileName 2.11.1 LogfileName example 2.12 MouseScroll 2.13 ScreenshotName 2.13.1 ScreenshotName example 3 Section: DataFiles 3.1 DataFiles example 4 Section: Messages 4.1 ActionVisible 4.2 ActionOffsetX 4.3 ActionOffsetY 4.4 ActionColor 4.5 DamageOffsetX 4.6 DamageOffsetY 4.7 DamageColor 4.8 FollowerExperience 5 Section: Timeouts 5.1 Timeouts example 5.2 Enabled 5.3 Direction 5.4 Font 5.5 NameColor 5.6 PositionX 5.7 PositionY 5.8 SpacingX 5.9 SpacingY 5.10 Transparency 5.11 ValueColor 5.12 Worldmap 5.13 WorldmapX 5.14 WorldmapY

Intro

"FOnline2238.cfg" is a configuration file for various FOnline 2238 specific features that don't exist in vanilla FOnline client, such as fog of war, on-screen timeouts and more. This file is not created by the installer or FOConfig.exe and is not required to run the game. If the file cannot be found in the FOnline directory, default values are used.

Remember, FOnline2238.cfg is NOT a replacement of "FOnline.cfg."

Note: You can easily edit this file with text editor, or use provided tool FO2238Config.exe instead.

Details

FOnline2238.cfg uses very simple INI-like format to configure various settings and features.

Basic configuration example

[2238]
DisplayNames=true

Notes:

• Lines starting with hash ("#"), semicolon (";") are ignored (may be used as comments)
• If file starts with UTF-8 BOM, it's simply stripped from first line

Section: 2238

Main section of FOnline2238.cfg, which holds most of configurable options.

---

Autosave

If possible, client will try to update config file every time you change setting in game, by using function keys, or a command. They will be used next time you start a game. Can be used in config file only.

Notes:

• with autosave enabled, all comments/empty lines will be removed

Type: boolean

Default: off

Awareness

See: awareness command

Type: boolean

Default: on

CombatMode

Sets default combat mode for encounters/quest maps. If this variable is present in FOnline2238.cfg, value from FOnline.cfg is ignored.
See also: combatmode command.

0: Both

1: Real-Time

2: Turn-Based

Type: number (unsigned)
Range: 0 to 2
Default: none

CustomIni

Allows to load different .ini files into client, what allows easier loading of custom client interfaces. You don't need to replace default/faction.ini anymore, just save file with your modifications and add it to CustomIni list.

New ini files are loaded parsed after loading all data files, for making "one file - one interface" possible.

Notes:

• if you want to load more than one file, separate it with pipe symbol (|)

Type: string

Default: none

DisplayNames

Turns on/off the display of character names above head. (Hotkey: F6)

Type: boolean

Default: off

DisplayTC

Turns on/off display of Town Control messages. (Hotkey: F11)

Type: boolean

Default: on

DisplayTCZones

Turns on/off displaying the Town Control capture zone. (Hotkey: F10)

0: don't display any info

1: display information text ("inside/outside capture zone") and zone borders

2: display information text ("inside/outside capture zone"), more visible zone borders

Type: number (unsigned)
Range: 0 to 2
Default: 0

Fog

Turns on/off fog of war displaying.

Type: boolean

Default: off

FogColor

Changes fog of war color.

Type: color (with alpha)

IgnoreLangChange

Pressing left alt and left shift or left control and left shift won't change input language.

Type: boolean

Default: off

LogfileName

Allows to change name of logfile (created after pressing F2 key). If name leads to subdirectories, they will be created automatically.

Special strings that can be used in filename: %DAY% %MONTH% %YEAR% %HOUR% %MINUTE% %SECOND% %EXTENSION% %CHARNAME% %CHARLEVEL%

Type: string

Default: none

LogfileName example

LogfileName=logs\%CHARNAME%\%YEAR%-%MONTH%-%DAY%_%HOUR%-%MINUTE%-%SECOND%.txt

MouseScroll

Turns on/off scrolling of map using mouse. (Hotkey: F8)

Type: boolean

Default: on

ScreenshotName

Allows to change name of screenshot file (created after pressing F3 key). If name leads to subdirectories, they will be created automatically. File extension should end with ".jpg", ".tga", ".png" to create file in one of these formats. Every other extensions sets format to BMP.

Special strings that can be used in filename: %DAY% %MONTH% %YEAR% %HOUR% %MINUTE% %SECOND% %EXTENSION% %CHARNAME% %CHARLEVEL%

Type: string

Default: none

ScreenshotName example

ScreenshotName=screenshots\%CHARNAME%\%YEAR%-%MONTH%-%DAY%_%HOUR%-%MINUTE%-%SECOND%.png

Section: DataFiles

Allows to load custom data files (in .dat and .zip formats) into client, for easy adding new interfaces, critter graphic etc. It is recommended to use this section, instead of DataFiles.cfg (which is overwritten on update).

Files are loaded in same order as specified in DataFiles section, (property type: string) after all default client files.

---

DataFiles example

[DataFiles]
Modification_Name=mymod.dat
Something_Better=awesome.zip

Note: See also Game Files

Section: Messages

Contains settings for various messages, which shows up for short time around character's head.

---

ActionVisible

Allows to turn on/off messages displayed when character uses specific items/skills on self or other critters.

Type: visibility

Default: head

ActionOffsetX

Horizontal position of message displayed when character uses specific items/skills on self or other critters. Final value is picked randomly from range specified.

Type: range (signed)

Default: -15 15

ActionOffsetY

Vertical position of message displayed when character uses specific items/skills on self or other critters. Final value is picked randomly from range specified.

Type: range (signed)

Default: -20

ActionColor

Color of message displayed when character uses specific items/skills on self or other critters. Final value is picked randomly from range specified.

Type: color

Default: 58 137 133

DamageOffsetX

Horizontal position of message with damage done to character. Final value is picked randomly from range specified.

Type: range (signed)

Default: -15 15

DamageOffsetY

Vertical position of message with damage done to character. Final value is picked randomly from range specified.

Type: range (signed)

Default: -20

DamageColor

Color of message with damage done to character.

Type: color

Default: 200 0 0

FollowerExperience

Displays followers experience/level changes (above head only).

NOTE: This message is visible only to follower master.

Type: boolean

Default: false

Section: Timeouts

---

Timeouts example

[Timeouts]
Direction=1
Font=7
PositionX=-218
PositionY=-119
SpacingX=120
SpacingY=20
NameColor=0 200 0
ValueColor=0 160 0
Transparency=55
Worldmap=1
WorldmapX=-240
WorldmapY=-75

---

Enabled

Turns on/off timeouts displaying.

Type: boolean

Default: on

Direction

Where new positions should be added.

0: down

1: up

Type: number (unsigned)
Range: 0 to 1
Default: 1

Font

Type: number (unsigned)
Range: 4 to 8
Default: 5

NameColor

Change color of timeouts names ("First Aid", "Gathering", etc.) using RGB format.

Type: color

Default: 0 255 0

PositionX

Set the start X position for displaying timeouts.

Example for negative values: PositionX=-200 ⇒ PositionX=(ScreenWidth-200)

Type: number (signed)

Default: -145

PositionY

Set the start Y position for displaying timeouts.

Example for negative values: PositionY=-200 ⇒ PositionY=(ScreenHeight-200)

Type: number (signed)

Default: -110

SpacingX

Set horizontal distance between start position of timeout name (set by PositionX) and its value.

Type: number (unsigned)

Default: 72

SpacingY

Set vertical distance between each timeout.

Type: number (unsigned)

Default: 10

Transparency

Set transparency level for cumulative timeouts while below threshold (affects only Crafting and Gathering)

Type: number (unsigned)
Range: 0 to 100
Default: 0

ValueColor

Change color of timeouts values ("7 seconds", "42 hours", etc.) using RGB format.

Type: color

Default: 0 255 0

Worldmap

Display timeouts while on world map.

Type: boolean

Default: off

WorldmapX

Timeouts position when on worldmap, see: PositionX

Type: number (signed)

Default: -145

WorldmapY

Timeouts position when on worldmap, see: PositionY

Type: number (signed)

Default: -110