FOnline2238.cfg

From FOnline: 2238 Wiki
(Difference between revisions)
Jump to: navigation, search
m (will be reworked shortly)
(merge of other pages)
Line 1: Line 1:
−
{{Outdated}}
+
== Intro ==
  
−
 
+
"FOnline2238.cfg" is a configuration file for various FOnline 2238 specific features that don't exist in vanilla [[FOnline]] client, such as [[#Fog|fog of war]], on-screen [[#Section:_Timeouts|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.
−
== Intro ==
+
−
"FOnline2238.cfg" is a configuration file for various FOnline 2238 specific features that don't exist in vanilla [[Fallout 2]] such as [[DataFiles|data files]] loading, 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 <u>'''NOT'''</u> a replacement of "[[FOnline.cfg]]."
 
Remember, FOnline2238.cfg is <u>'''NOT'''</u> a replacement of "[[FOnline.cfg]]."
Line 9: Line 7:
 
'''Note:''' You can easily edit this file with text editor, or use provided tool [[FO2238Config.exe]] instead.
 
'''Note:''' You can easily edit this file with text editor, or use provided tool [[FO2238Config.exe]] instead.
  
−
== Details ==
+
=== Details ===
  
 
FOnline2238.cfg uses very simple [http://en.wikipedia.org/wiki/INI_file INI]-like format to configure various settings and features.
 
FOnline2238.cfg uses very simple [http://en.wikipedia.org/wiki/INI_file INI]-like format to configure various settings and features.
Line 23: Line 21:
 
* If file starts with [http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark UTF-8 BOM], it's simply stripped from first line
 
* If file starts with [http://en.wikipedia.org/wiki/UTF-8#Byte_order_mark UTF-8 BOM], it's simply stripped from first line
  
−
=== Settings types ===
 
  
−
==== boolean ====
+
== Section: 2238 ==
−
Sets value to '''true''' or '''false'''. To set value to '''true''', use one of following:
+
  
−
* true
+
Main section of FOnline2238.cfg, which holds most of configurable options.
−
* yes
+
−
* on
+
−
* 1
+
  
−
Everything else sets value to '''false'''
+
----
  
−
<pre>
+
=== Autosave ===
−
CampOnWorldmap=0
+
−
NeverUseAlts=true
+
−
</pre>
+
  
−
==== string ====
+
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.
−
Accepts any text You specify.
+
  
−
<pre>
+
Notes:
−
BadBoy=Metzger
+
* with autosave enabled, all comments/empty lines will be removed
−
GoodBoy=Harold and his tree
+
 
−
</pre>
+
{{ConfigurationVar|type=boolean|default=off}}
 +
 
 +
=== Awareness ===
 +
 
 +
See: [[Commands|awareness]] command
 +
 
 +
{{ConfigurationVar|type=boolean|default=on}}
 +
 
 +
=== CombatMode ===
 +
 
 +
Sets default combat mode for encounters/quest maps. If this variable is present in FOnline2238.cfg, <u>value from FOnline.cfg is ignored</u>.<br/>
 +
See also: [[Commands|combatmode]] command.
 +
 
 +
0: Both
 +
 
 +
1: Real-Time
 +
 
 +
2: Turn-Based
 +
 
 +
{{ConfigurationVar|type=number|info=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 [[DataFiles|data files]], for making "one file - one interface" possible.
 +
 
 +
Notes:
 +
* if you want to load more than one file, separate it with pipe symbol (|)
 +
 
 +
{{ConfigurationVar|type=string|default=none}}
 +
 
 +
=== DisplayNames ===
 +
 
 +
Turns on/off the display of character names above head. (Hotkey: '''F6''')
 +
 
 +
{{ConfigurationVar|type=boolean|default=off}}
 +
 
 +
=== DisplayTC ===
 +
 
 +
Turns on/off display of [[Town Control]] messages. (Hotkey: '''F11''')
 +
 
 +
{{ConfigurationVar|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
 +
 
 +
{{ConfigurationVar|type=number|info=unsigned|range=0 to 2|default=0}}
 +
 
 +
=== Fog ===
 +
 
 +
Turns on/off ''fog of war'' displaying.
 +
 
 +
{{ConfigurationVar|type=boolean|default=off}}
 +
 
 +
=== FogColor ===
 +
 
 +
Changes ''fog of war'' color.
 +
 
 +
{{ConfigurationVar|type=color|info=with alpha}}
 +
 
 +
=== IgnoreLangChange ===
 +
 
 +
Pressing ''left alt and left shift'' or ''left control and left shift'' won't change input language.
 +
 
 +
{{ConfigurationVar|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%
 +
 
 +
{{ConfigurationVar|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''')
 +
 
 +
{{ConfigurationVar|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%
 +
 
 +
{{ConfigurationVar|type=string|default=none}}
 +
 
 +
==== ScreenshotName example ====
 +
 
 +
''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 ==
 +
 
 +
Allows to load custom data files (in .[http://www.falloutwiki.com/DAT_files dat] and .[http://en.wikipedia.org/wiki/ZIP_%28file_format%29 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: '''[[Configuration#string|string]]''') after all default client files.
 +
 
 +
----
  
−
==== number ====
+
=== DataFiles example ===
−
Number can be '''signed''' (-1207, 0, 1337, etc.) or '''unsigned''' (0, 1337, etc; if negative value is given, it defaults to 0).
+
  
 
<pre>
 
<pre>
−
LuckyNumber=7
+
[DataFiles]
−
BluesuitsKilled=5000
+
Modification_Name=mymod.dat
−
MyBarterSkill=-5
+
Something_Better=awesome.zip
 
</pre>
 
</pre>
  
−
==== color ====
+
'''Note:''' See also [[Game Files]]
−
Accepts values in [http://en.wikipedia.org/wiki/RGB_color_model RGB format].
+
  
 +
== Timeouts ==
 +
 +
blah
 +
 +
----
 +
 +
==== Timeouts example ====
 
<pre>
 
<pre>
−
Green=0 255 0
+
[Timeouts]
−
Red=255 0 0
+
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
 
</pre>
 
</pre>
  
 +
[[File:Timeouts_example.png]]
 +
----
 +
 +
=== Enabled ===
 +
 +
Turns on/off timeouts displaying.
 +
 +
{{ConfigurationVar|type=boolean|default=on}}
 +
 +
=== Direction ===
 +
 +
Where new positions should be added.
 +
 +
0: down
 +
 +
1: up
 +
 +
{{ConfigurationVar|type=number|info=unsigned|range=0 to 1|default=1}}
 +
 +
=== Font ===
 +
 +
{{ConfigurationVar|type=number|info=unsigned|range=4 to 8|default=5}}
 +
 +
=== NameColor ===
 +
 +
Change color of timeouts names  ("''First Aid''", "''Gathering''", etc.) using [http://en.wikipedia.org/wiki/RGB_color_model RGB format].
 +
 +
{{ConfigurationVar|type=color|default=0 255 0}}
 +
 +
=== PositionX ===
 +
 +
Set the start X position for displaying timeouts.
 +
 +
Example for negative values: PositionX=-200 &rArr; PositionX=(ScreenWidth-200)
 +
 +
{{ConfigurationVar|type=number|info=signed|default=-145}}
 +
 +
=== PositionY ===
 +
 +
Set the start Y position for displaying timeouts.
 +
 +
Example for negative values: PositionY=-200 &rArr; PositionY=(ScreenHeight-200)
 +
 +
{{ConfigurationVar|type=number|info=signed|default=-110}}
 +
 +
=== SpacingX ===
 +
 +
Set horizontal distance between start position of timeout name (set by [[#PositionX|PositionX]]) and its value.
 +
 +
{{ConfigurationVar|type=number|info=unsigned|default=72}}
 +
 +
=== SpacingY ===
 +
 +
Set vertical distance between each timeout.
 +
 +
{{ConfigurationVar|type=number|info=unsigned|default=10}}
 +
 +
=== Transparency ===
 +
 +
Set transparency level for cumulative timeouts while below threshold (affects only ''Crafting'' and ''Gathering'')
 +
 +
{{ConfigurationVar|type=number|info=unsigned|range=0 to 100|default=0}}
 +
 +
=== ValueColor ===
 +
 +
Change color of timeouts values ("''7 seconds''", "''42 hours''", etc.) using [http://en.wikipedia.org/wiki/RGB_color_model RGB format].
 +
 +
{{ConfigurationVar|type=color|default=0 255 0}}
 +
 +
=== Worldmap ===
 +
 +
Display timeouts while on world map.
 +
 +
{{ConfigurationVar|type=boolean|default=off}}
 +
 +
=== WorldmapX ===
 +
 +
Timeouts position when on worldmap, see: [[#PositionX|PositionX]]
  
−
== FOnline2238.cfg sections ==
+
{{ConfigurationVar|type=number|info=signed|default=-145}}
−
These articles describe each section of this configuration file.
+
−
*[[2238]]
+
  
−
*[[Timeouts]]
+
=== WorldmapY ===
  
−
*[[DataFiles]]
+
Timeouts position when on worldmap, see: [[#PositionY|PositionY]]
  
−
*[[Bindings]]
+
{{ConfigurationVar|type=number|info=signed|default=-110}}
  
 
[[Category:Configuration]]
 
[[Category:Configuration]]

Revision as of 23:00, 28 November 2012

Contents

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

VerboseActionHead

Displays message above character, when (s)he uses specifing items/skills on self or other critters.

Type: boolean

Default: on

VerboseActionBox

Displays information in messagebox, when given character uses specifing items/skills on self or other critters.

Type: boolean

Default: off

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

Timeouts

blah

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

Timeouts example.png

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

Retrieved from "https://fo2238.fodev.net/wiki/index.php?title=FOnline2238.cfg&oldid=25360"
Personal tools
Contribute