ConfigurationFiles.wiki
author Wuzzy
Thu, 07 Apr 2016 19:40:46 +0100
changeset 861 ccbc115e68ad
parent 759 357ba2e4ea16
child 872 8aa46333bfe2
permissions -rw-r--r--
LuaAPI: fix broken onGameInit table
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     1
#summary Documentation of configuration files on desktop
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     2
#labels Documentation
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     3
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
     4
= Configuration files =
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
     5
== Introduction ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     6
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     7
This documents the structure and content of the configuration (.ini) files found in the desktop version of Hedgewars.
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     8
759
357ba2e4ea16 ConfigurationFiles: Fix max_depth parameter
Wuzzy
parents: 758
diff changeset
     9
<wiki:toc max_depth="2" />
166
26202b9ff10d Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 165
diff changeset
    10
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    11
== `hedgewars.ini` ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    12
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    13
=== {{{[video]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    14
_Graphics rendering settings, back-end (engine)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    15
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    16
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    17
|| resolution=1280x768 || String || Screen resolution the game is rendered at ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    18
|| fullscreen=false || Boolean || If the game is rendered in fullscreen ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    19
|| quality=5 || Integer || Quality of game rendering ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    20
|| stereo=0 || Integer || Mode of stereoscopic 3D rendering, 0 being no 3D ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    21
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    22
=== {{{[frontend]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    23
_Graphics and sound settings, front-end (GUI)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    24
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    25
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    26
|| effects=true || Boolean || If game effects are displayed ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    27
|| fullscreen=false || Boolean || If the game is in fullscreen-mode, instead of windowed-mode ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    28
|| width=800 || Integer || Width of the game window ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    29
|| height=600 || Integer || Height of the game window ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    30
|| sound=true || Boolean || If sounds are being played ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    31
|| music=true || Boolean || If background music is being played ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    32
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    33
=== {{{[misc]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    34
_Miscellaneous settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    35
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    36
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    37
|| weaponTooltips=true || Boolean || If tooltips should be shown in the ammo menu ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    38
|| altdamage=false || Boolean || If damage pop-ups should be shown on every shot, instead of only at the end of a round ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    39
|| appendTimeToRecords=false || Boolean || If date and time should be appended to the file name when demo records are saved ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    40
|| 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 ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    41
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    42
=== {{{[audio]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    43
_Sound rendering settings, back-end_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    44
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    45
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    46
|| sound=true || Boolean || If sound effects should be rendered ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    47
|| music=true || Boolean || If background music should be rendered ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    48
|| volume=100 || Integer || Volume level of sound effects and music rendering ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    49
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    50
=== {{{[net]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    51
_Online and LAN settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    52
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    53
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    54
|| nick=username || String || Username/nickname used for online play, or promt the user when first connecting if left blank ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
    55
|| passwordhash=@!ByteArray(d41d8cd98f00b204e9800998ecf8427e) || Byte array || Hash of password used for online play ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    56
|| passwordlength=0 || Integer || Lenght of unhashed password string ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    57
|| ip=10.0.0.0 || String || Default IP-address when connecting to a LAN server, stored in human-readable dot-notation ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    58
|| port=46631 || Integer || Default port number when connecting to a LAN server ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    59
|| servername=hedgewars server || String || Default name when creating a LAN server ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    60
|| serverport=46631 || Integer || Default port number when creating a LAN server ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    61
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    62
=== {{{[fps]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    63
_Frames per second settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    64
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    65
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    66
|| show=false || Boolean || If the number of frames rendered per second should be shown in-game ||
168
f4f73967aa4e Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 167
diff changeset
    67
|| limit=27 || Integer || Maximum number of frames rendered per second, calculated as _1000 / (35 - limit)_ ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    68
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    69
== `weapons.ini` ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    70
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    71
=== {{{[General]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    72
_List of weapon settings as key-value pairs, each with a string name and integer value_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    73
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    74
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    75
|| Default=93919...11101 || Integer || Which weapons are allowed in the default mode ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    76
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    77
== `settings.ini` ==
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    78
Various Hedgewars settings.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    79
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    80
=== {{{Binds}}} ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    81
This section defines the global key bindings. They can be overwritten by teams.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    82
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    83
Each key binding is written in the form `action=keycode`, e.g. “`ammomenu=b`” for opening the ammo menu with the B key.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    84
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    85
==== Actions ====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    86
|| *Setting* || *Description* ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    87
|| %2Bup || Up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    88
|| %2Bleft || Left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    89
|| %2Bright || Right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    90
|| %2Bdown || Down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    91
|| %2Bprecise || Precise ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    92
|| ljump || Long jump ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    93
|| hjump || High jump ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    94
|| switch || Switch hog ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    95
|| ammomenu || Ammo menu ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    96
|| slot%201 || Slot 1 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    97
|| slot%202 || Slot 2 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    98
|| slot%203 || Slot 3 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
    99
|| slot%204 || Slot 4 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   100
|| slot%205 || Slot 5 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   101
|| slot%206 || Slot 6 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   102
|| slot%207 || Slot 7 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   103
|| slot%208 || Slot 8 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   104
|| slot%209 || Slot 9 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   105
|| slot%20%3A || Slot 10 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   106
|| timer%201 || Timer: 1 second ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   107
|| timer%202 || Timer: 2 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   108
|| timer%203 || Timer: 3 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   109
|| timer%204 || Timer: 4 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   110
|| timer%205 || Timer: 5 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   111
|| %2Battack || Attack ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   112
|| put || Place hedgehog or select target ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   113
|| findhh || Automatic camera / find hedgehog ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   114
|| %2Bcur_u || Move camera or cursor up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   115
|| %2Bcur_l || Move camera or cursor left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   116
|| %2Bcur_r || Move camera or cursor right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   117
|| %2Bcur_d || Move camera or cursor down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   118
|| zoomin || Zoom in ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   119
|| zoomout || Zoom out ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   120
|| zoomreset || Reset zoom ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   121
|| chat || Open chat input ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   122
|| history || Toggle chat history ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   123
|| pause || Toggle pause ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   124
|| quit || Quit ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   125
|| confirm || Confirm ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   126
|| %2Bvoldown || Raise volume ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   127
|| %2Bvolup || Lower volume ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   128
|| mute || Mute ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   129
|| fullscr || Toggle window mode (window/fullscreen) ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   130
|| capture || Take screenshot ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   131
|| %2Bspeedup || Increase demo replay speed ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   132
|| rotmask || Cycle tags above hedgehogs ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   133
|| record || Record video ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   134
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   135
==== Key codes ====
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   136
===== Keyboard =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   137
Keyboard names are based on the [https://wiki.libsdl.org/SDL_Scancode SDL scancode].
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   138
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   139
The key name is constructed as follows:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   140
677
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   141
 * Take the name from the “Key Name” column of the aforementioned webpage
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   142
 * Convert it to lower-case
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   143
 * Replace spaces with underscores
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   144
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   145
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   146
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   147
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   148
|| `a` || A ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   149
|| `f1` || F1 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   150
|| `shift_left` || Left shift key ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   151
|| `space` || Space bar ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   152
|| `tab` || Tabulator ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   153
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   154
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   155
===== Mouse =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   156
The codes for the mouse are as follows:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   157
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   158
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   159
|| `mousel` || Left mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   160
|| `mousem` || Middle mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   161
|| `mouser` || Right mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   162
|| `wheelup` || Mouse wheel up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   163
|| `wheeldown` || Mouse wheel down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   164
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   165
===== Controller/Gamepad/Joystick =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   166
Controllers, gamepads and joysticks are written in a somewhat cryptic syntax.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   167
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   168
====== Buttons ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   169
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   170
Syntax: `jJbB`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   171
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   172
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   173
 * `A`: Button ID beginning with 0
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   174
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   175
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   176
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   177
|| `j0b0` || First controller, first button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   178
|| `j0b1` || First controller, second button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   179
|| `j1b2` || Second controller, third button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   180
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   181
====== Axes ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   182
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   183
Syntax: `jJaAD`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   184
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   185
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   186
 * `A`: Axis 
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   187
 * `D`: Axis direction. One of the following letters:
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   188
  * `u`: positive (“up”)
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   189
  * `d`: negative (“down”)
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   190
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   191
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   192
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   193
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   194
|| `j0a0u` || First controller, first axis up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   195
|| `j0a1d` || First controller, second axis down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   196
|| `j1a1d` || Second controller, second axis down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   197
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   198
====== Hats/D-pads ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   199
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   200
Syntax: `jJhHD`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   201
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   202
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   203
 * `A`: D-pad ID 
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   204
 * `D`: Direction, it is one of 4 letters:
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   205
  * `u`: up
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   206
  * `r`: right
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   207
  * `d`: down
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   208
  * `l`: left
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   209
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   210
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   211
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   212
|| `j0h0u` || First controller, first D-pad up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   213
|| `j0h1l` || First controller, second D-pad left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   214
|| `j1h1r` || Second controller, second D-pad right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   215
674
e3f2f797fbd0 Syntax fix (2)
Wuzzy
parents: 673
diff changeset
   216
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   217
=== Other sections ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   218
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   219
_To be written …_
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   220
674
e3f2f797fbd0 Syntax fix (2)
Wuzzy
parents: 673
diff changeset
   221
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   222
== `schemes.ini` ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   223
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   224
=== {{{[schemes]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   225
_List of custom scheme settings as key-value pairs, each with a key of "index number of scheme backslash setting name"_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   226
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   227
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   228
|| size=1 || Integer || Number of custom scheme settings ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   229
|| 1\name=new || String || Name of scheme ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   230
|| 1\fortsmode=false || Boolean || If forts are enabled ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   231
|| 1\divteams=false || Boolean || If teams start at the opposite side of the terrain ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   232
|| 1\solidland=false || Boolean || If land is indestructible ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   233
|| 1\border=false || Boolean || If an insestructible border is added around the map ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   234
|| 1\lowgrav=false || Boolean || If gravity is lowered ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   235
|| 1\laser=false || Boolean || If aiming is assisted with laser sights ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   236
|| 1\invulnerability=false || Boolean || If hogs have a personal forcefield ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   237
|| 1\resethealth=false || Boolean || If living hogs' health is reset to 100 at end of round ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   238
|| 1\vampiric=false || Boolean || If hogs gain life equal to 80 percent of the damage they deal ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   239
|| 1\karma=false || Boolean || If hogs lose life equal to the damage they deal ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   240
|| 1\artillery=false || Boolean || If hogs are unable to move ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   241
|| 1\randomorder=true || Boolean || If turn order is generated randomly ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   242
|| 1\king=false || Boolean || If a chess-like king is used ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   243
|| 1\placehog=false || Boolean || If players take turns placing their hogs before the start of a game ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   244
|| 1\sharedammo=false || Boolean || If ammo is shared between all teams of the same color ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   245
|| 1\disablegirders=false || Boolean || If girders are removed from randomly-generated maps ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   246
|| 1\disablelandobjects=false || Boolean || If land objects are removed from randomly-generated maps ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   247
|| 1\aisurvival=false || Boolean || If AI hogs respawn on death ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   248
|| 1\infattack=false || Boolean || If hogs can attack an unlimited number of times each turn ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   249
|| 1\resetweps=false || Boolean || If weapons are reset at end of each turn ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   250
|| 1\perhogammo=false || Boolean || If each hog has seperate ammo ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   251
|| 1\disablewind=false || Boolean || If wind is disabled ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   252
|| 1\morewind=false || Boolean || If wind is much stronger then usually ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   253
|| 1\tagteam=false || Boolean || If players in a team share time on each turn ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   254
|| 1\bottomborder=false || Boolean || If an indestructible border is added at the bottom of the map ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   255
|| 1\damagefactor=100 || Integer || Percentage of damage dealt ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   256
|| 1\turntime=45 || Integer || Maximum time in seconds of each turn ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   257
|| 1\health=100 || Integer || The initial health of the hogs ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   258
|| 1\suddendeath=15 || Integer || Turns before "Sudden Death" mode begins ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   259
|| 1\caseprobability=5 || Integer || Number of turns between cases drops ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   260
|| 1\minestime=3 || Integer || Seconds before mines explode ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   261
|| 1\minesnum=4 || Integer || Number of mines on a level ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   262
|| 1\minedudpct=0 || Integer || Percentage chance of each mine being a dud ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   263
|| 1\explosives=2 || Integer || Number of explosives on a level ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   264
|| 1\healthprobability=35 || Integer || Percentage chance of each crate being a health crate ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   265
|| 1\healthcaseamount=25 || Integer || Amount of life restored by each health crate ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   266
|| 1\waterrise=47 || Integer || Number of pixels the water rises each turn in "Sudden Death" mode ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   267
|| 1\healthdecrease=5 || Integer || Damage dealth each turn to hogs in water during "Sudden Death" mode ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   268
|| 1\ropepct=100 || Integer || Maximum length of rope as a percentage ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   269
|| 1\getawaytime=100 || Integer || Time you have to get away from an explosive after arming it, as a percentage ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   270
|| 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. ||
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   271
|| 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. ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   272
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   273
== `TeamName.hwt` ==
671
f99b16de1060 Better description of TeamName.hwt
Wuzzy
parents: 644
diff changeset
   274
These files are found in the `Teams` directory and contain the team settings, one file per team.
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   275
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   276
=== {{{[Team]}}} ===
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   277
_General team settings_
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   278
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   279
|| *Setting* || *Type* || *Description* ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   280
|| Name=!TeamName || String || Name of team ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   281
|| Grave=Statue || String || Type of grave created when hog dies ||
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   282
|| Fort=Plane || String || Type of fort if Forts Mode is enabled ||
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   283
|| Voicepack=Default || String || Sounds used for hog voice ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   284
|| Flag=hedgewars || String || Name of flag (flag file name without suffix). This is ignored for AI teams; their flags will always be based on their difficulty level ||
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   285
|| Difficulty=0 || Integer || Diffuculty of AI (1-5, 1 = most difficult), or human if 0 ||
168
f4f73967aa4e Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 167
diff changeset
   286
|| Rounds=0 || Integer || Number of rounds played with team _(Currently unused)_ ||
f4f73967aa4e Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 167
diff changeset
   287
|| Wins=0 || Integer || Number of rounds won with team _(Currently unused)_ ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   288
|| !CampaignProgress=0 || Integer || Campain progress using team as a percentage _(Currently unused)_ ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   289
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   290
=== {{{[Hedgehog0]}}} - {{{[Hedgehog7]}}} ===
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   291
_8 sections, one per hedgehog of the team_
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   292
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   293
|| *Setting* || *Type* || *Description* ||
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   294
|| Name=Hedgehog Name || String || Name of hog ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   295
|| Hat=!NoHat || String || Type of hat used by hog ||
168
f4f73967aa4e Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 167
diff changeset
   296
|| Rounds=0 || Integer || Number of rounds played with hog _(Currently unused)_ ||
f4f73967aa4e Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 167
diff changeset
   297
|| Kills=0 || Integer || Kills comitted by hog _(Currently unused)_ ||
f4f73967aa4e Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 167
diff changeset
   298
|| Deaths=0 || Integer || Deaths experienced by hog _(Currently unused)_ ||
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   299
|| Suicides=0 || Integer || Suicides comitted by hog _(Currently unused)_ ||
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   300
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   301
=== {{{[Binds]}}} ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   302
Key bindings of the team. Teams can optionally overwrite the global key bindings or leave everything at default.
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   303
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   304
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.
643
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   305
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   306
==== Values ====
643
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   307
The special value “`default`” is for the default keybinding as specified in the game preferences.
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   308
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   309
Regarding other keys: _TO BE WRITTEN_
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   310
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   311
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   312
=== {{{[Campaign%20<CAMPAIGN_NAME>]}}} ===
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   313
This section stores campaign variables which are stored and read by Lua scripts. Replace “`<CAMPAIGN_NAME>` with the folder name of the campaign. Example: The section for “A Classic Fairytale” would be “`[Campaign%20A_Classic_Fairytale]`”.
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   314
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   315
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.
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   316
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   317
Campaign variable names and their values can are chosen by the Lua script authors, but there are some special variables which are used to determine which missions are available in the main menu:
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   318
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   319
|| *Setting* || *Type* || *Description* ||
582
96dd549eeead Typo fixes.
almikes@aol.com
parents: 581
diff changeset
   320
|| `Progress` || Integer || If present, this number of missions _additional to the first mission_ are unlocked in the menu, starting with the second mission and continuing with the following missions in their regular order (as specified in `campaign.ini`). If the number is `0`, only the first mission is available. ||
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   321
|| `UnlockedMissions` || Integer || An alternative way to store the unlocked missions in the main menu if the missions aren't unlocked in the regular order. This number specifies how many missions are unlocked. If this variable is set, then the variables `Mission1`, `Mission2`, etc. must be used to specfify the IDs of the unlocked missions. ||
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   322
|| `Mission1` || Integer || The `campaign.ini` ID of the first unlocked mission, must be used together with `UnlockedMissions` ||
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   323
|| `Mission2` || Integer || ID of the second unlocked mission (continues with `Mission3`, `Mission4`, and so on) ||
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   324
581
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   325
If neither `Progress` nor `UnlockedMissions` are present, only the first mission is unlocked.
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   326
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   327
==== Examples ====
581
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   328
Simple campaign with 10 missions, missions 1-5 are available:
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   329
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   330
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   331
[Campaign%20Simple_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   332
Progress=4
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   333
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   334
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   335
Complex campaign with 13 missions, missions 2, 7 and 3 are available (in that order):
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   336
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   337
[Campaign%20Complex_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   338
UnlockedMissions=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   339
Mission1=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   340
Mission2=7
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   341
Mission3=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   342
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   343
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   344
Another campaign with some custom campaign variables:
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   345
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   346
[Campaign%20Another_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   347
Progress=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   348
MyCustomVariable=54
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   349
MyCustomString=Hedgewars
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   350
}}}