diff -r 0ac49c33cf3e -r ecdd12db8754 ConfigurationFiles.wiki --- a/ConfigurationFiles.wiki Sun Jan 17 12:55:30 2016 +0000 +++ b/ConfigurationFiles.wiki Sun Jan 17 12:57:26 2016 +0000 @@ -1,15 +1,16 @@ #summary Documentation of configuration files on desktop #labels Documentation -= Introduction = += Configuration files = +== Introduction == This documents the structure and content of the configuration (.ini) files found in the desktop version of Hedgewars. - + -= `hedgewars.ini` = +== `hedgewars.ini` == -== {{{[video]}}} == +=== {{{[video]}}} === _Graphics rendering settings, back-end (engine)_ || *Setting* || *Type* || *Description* || @@ -18,7 +19,7 @@ || quality=5 || Integer || Quality of game rendering || || stereo=0 || Integer || Mode of stereoscopic 3D rendering, 0 being no 3D || -== {{{[frontend]}}} == +=== {{{[frontend]}}} === _Graphics and sound settings, front-end (GUI)_ || *Setting* || *Type* || *Description* || @@ -29,7 +30,7 @@ || sound=true || Boolean || If sounds are being played || || music=true || Boolean || If background music is being played || -== {{{[misc]}}} == +=== {{{[misc]}}} === _Miscellaneous settings_ || *Setting* || *Type* || *Description* || @@ -38,7 +39,7 @@ || appendTimeToRecords=false || Boolean || If date and time should be appended to the file name when demo records are saved || || locale=en_US || String || Language used in game in the format "ISO 639-1 Code underscore ISO 3166-1 alpha-2 Code", or system default if left blank || -== {{{[audio]}}} == +=== {{{[audio]}}} === _Sound rendering settings, back-end_ || *Setting* || *Type* || *Description* || @@ -46,7 +47,7 @@ || music=true || Boolean || If background music should be rendered || || volume=100 || Integer || Volume level of sound effects and music rendering || -== {{{[net]}}} == +=== {{{[net]}}} === _Online and LAN settings_ || *Setting* || *Type* || *Description* || @@ -58,30 +59,30 @@ || servername=hedgewars server || String || Default name when creating a LAN server || || serverport=46631 || Integer || Default port number when creating a LAN server || -== {{{[fps]}}} == +=== {{{[fps]}}} === _Frames per second settings_ || *Setting* || *Type* || *Description* || || show=false || Boolean || If the number of frames rendered per second should be shown in-game || || limit=27 || Integer || Maximum number of frames rendered per second, calculated as _1000 / (35 - limit)_ || -= `weapons.ini` = +== `weapons.ini` == -== {{{[General]}}} == +=== {{{[General]}}} === _List of weapon settings as key-value pairs, each with a string name and integer value_ || *Setting* || *Type* || *Description* || || Default=93919...11101 || Integer || Which weapons are allowed in the default mode || -= `settings.ini` = +== `settings.ini` == Various Hedgewars settings. -== {{{Binds}}} == +=== {{{Binds}}} === This section defines the global key bindings. They can be overwritten by teams. Each key binding is written in the form `action=keycode`, e.g. “`ammomenu=b`” for opening the ammo menu with the B key. -=== Actions === +==== Actions ==== || *Setting* || *Description* || || %2Bup || Up || || %2Bleft || Left || @@ -131,8 +132,8 @@ || rotmask || Cycle tags above hedgehogs || || record || Record video || -=== Key codes === -==== Keyboard ==== +==== Key codes ==== +===== Keyboard ===== Keyboard names are based on the [https://wiki.libsdl.org/SDL_Scancode SDL scancode]. The key name is constructed as follows: @@ -151,7 +152,7 @@ || `tab` || Tabulator || -==== Mouse ==== +===== Mouse ===== The codes for the mouse are as follows: || *Code* || Description || @@ -161,10 +162,10 @@ || `wheelup` || Mouse wheel up || || `wheeldown` || Mouse wheel down || -==== Controller/Gamepad/Joystick ==== +===== Controller/Gamepad/Joystick ===== Controllers, gamepads and joysticks are written in a somewhat cryptic syntax. -===== Buttons ===== +====== Buttons ====== Syntax: `jJbB` @@ -177,7 +178,7 @@ || `j0b1` || First controller, second button || || `j1b2` || Second controller, third button || -===== Axes ===== +====== Axes ====== Syntax: `jJaAD` @@ -194,7 +195,7 @@ || `j0a1d` || First controller, second axis down || || `j1a1d` || Second controller, second axis down || -===== Hats/D-pads ===== +====== Hats/D-pads ====== Syntax: `jJhHD` @@ -213,14 +214,14 @@ || `j1h1r` || Second controller, second D-pad right || -== Other sections == +=== Other sections === _To be written …_ -= `schemes.ini` = +== `schemes.ini` == -== {{{[schemes]}}} == +=== {{{[schemes]}}} === _List of custom scheme settings as key-value pairs, each with a key of "index number of scheme backslash setting name"_ || *Setting* || *Type* || *Description* || @@ -269,10 +270,10 @@ || 1\worldedge=0 || Integer || Type of world edges at the left and right side. `0` for no edge (default), `1` for wrap-around, `2` for bouncy edges, `3` for ocean. || || 1\scriptparam="" || String || 0.9.21: Script parameter, this is read by scripts. Can have any arbitrary srting value, the meaning of this value depends on the script used. || -= `TeamName.hwt` = +== `TeamName.hwt` == These files are found in the `Teams` directory and contain the team settings, one file per team. -== {{{[Team]}}} == +=== {{{[Team]}}} === _General team settings_ || *Setting* || *Type* || *Description* || @@ -286,7 +287,7 @@ || Wins=0 || Integer || Number of rounds won with team _(Currently unused)_ || || !CampaignProgress=0 || Integer || Campain progress using team as a percentage _(Currently unused)_ || -== {{{[Hedgehog0]}}} - {{{[Hedgehog7]}}} == +=== {{{[Hedgehog0]}}} - {{{[Hedgehog7]}}} === _8 sections, one per hedgehog of the team_ || *Setting* || *Type* || *Description* || @@ -297,18 +298,18 @@ || Deaths=0 || Integer || Deaths experienced by hog _(Currently unused)_ || || Suicides=0 || Integer || Suicides comitted by hog _(Currently unused)_ || -== {{{[Binds]}}} == +=== {{{[Binds]}}} === Key bindings of the team. Teams can optionally overwrite the global key bindings or leave everything at default. This section follows the same format as in `settings.ini`, with one addition: The key code `default` is used for using the default (global) key binding. -=== Values === +==== Values ==== The special value “`default`” is for the default keybinding as specified in the game preferences. Regarding other keys: _TO BE WRITTEN_ -== {{{[Campaign%20]}}} == +=== {{{[Campaign%20]}}} === This section stores campaign variables which are stored and read by Lua scripts. Replace “`` with the folder name of the campaign. Example: The section for “A Classic Fairytale” would be “`[Campaign%20A_Classic_Fairytale]`”. Campaign variables are stored on a key-value basis, where the key is the name of the campaign variable and the value is the value of the campaign variable. @@ -323,7 +324,7 @@ If neither `Progress` nor `UnlockedMissions` are present, only the first mission is unlocked. -=== Examples === +==== Examples ==== Simple campaign with 10 missions, missions 1-5 are available: {{{