Configuration file is regular text file that can contain comments, empty lines and configuration definitions.
Every line that has hashmark (#) as its first character is comment line and will be ignored.
The general syntax for any of configuration options is:
keyword: <value>
All configuration option keywords are case incensitive
Most of option keywords can have three additional suffixes to enable fine tuning of options:
keyword.observer: <value>
- this suffix will enable
option only in case you are logged in to server as observer
Example:
buttonmap.observer: 1l2I3i
- will set different buttonmap when you
observe game
keyword.<servernick>: <value>
- this suffix will
set option only if you are connected to server <servernick>
Note that in order to define <servernick> you should define
server.<servernick>: <server host name>
Example:
server.continuum: continuum.us.netrek.org
- this option sets
servernick for continuum.us.netrek.org to be continuum
keymap.continuum: a2d%
- this option defines custom keymap for
server with 'continuum' as its servernick
keyword.<servertype>: <value>
- this suffix will
set option only if you are connected to server with <servertype> type.
Note: the client will automatically set <servertype> only if you connect from Metaserver Window
If you want to define <servertype> for specific server that is not there or
you connect to server from command line you can use servertype.<servernick>: <type of server>
where
<type of server> can be one of following:
paradise
bronco
chaos
inl
sturgeon
hockey
dogfight
Example:
server.continuum: continuum.us.netrek.org
- this will set servernick
for continuum.us.netrek.org to be continuum
serverType.continuum: bronco
- this will set servertype for continuum
to be bronco
keymap.bronco: a2d%
- this will set keymap for any bronco server
The precedence for the keywords is as follows:
keyword.observer: <value>
keyword.<servernick>: <value>
keyword.<servertype>: <value>
keyword: <value>
There are three types of values that can appear in the configuration:
Examples:
keepPeace: on
- will enable keepPeace optionplanetBitmap: 2
- will assign value of 2 to planetBitmap optionbuttonmap: 1t2p3k
- will assign string '1t2p3k' to buttonmap option