ConfigurationFiles.wiki
author Wuzzy
Thu, 20 Apr 2017 04:08:58 +0100
changeset 983 db3da219be63
parent 928 20cb05132905
child 1045 54979ae0e5ac
permissions -rw-r--r--
Taunts: Add list of unused taunts
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
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
    11
== `settings.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* ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    17
|| fullscreenResolution=1280x768 || String || Screen resolution the game is rendered when using fullscreen mode ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    18
|| windowedWidth=1280 || Integer || Window width when using window mode ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    19
|| windowedHeight=1024 || Integer || Window height when using window mode ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    20
|| fullscreen=false || Boolean || If the game is rendered in fullscreen ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    21
|| quality=5 || Integer || Quality of game rendering (0-5, 5 is best quality) ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    22
|| 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
    23
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    24
=== {{{[frontend]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    25
_Graphics and sound settings, front-end (GUI)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    26
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    27
|| *Setting* || *Type* || *Description* ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    28
|| roomslist_header || ??? || ??? ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    29
|| roomslist_splitter || ??? || ??? ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    30
|| effects=true || Boolean || If game effects are displayed ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    31
|| 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
    32
|| width=800 || Integer || Width of the game window ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    33
|| height=600 || Integer || Height of the game window ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    34
|| sound=true || Boolean || If sounds are being played in the frontend ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    35
|| music=true || Boolean || If background music is being played in the frontend ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    36
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    37
=== {{{[misc]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    38
_Miscellaneous settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    39
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    40
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    41
|| 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
    42
|| 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
    43
|| 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
    44
|| 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 ||
874
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    45
|| teamtag || Boolean || Whether to show the team name above hedgehogs by default ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    46
|| hogtag || Boolean || Whether to show the hog name above hedgehogs by default ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    47
|| healthtag || Boolean || Whether to show the health above hedgehogs by default ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    48
|| tagopacity || Boolean || If true, name and health tags above hedgehogs are translucent ||
161
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
=== {{{[audio]}}} ===
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    51
_Sound settings for the sounds and music in the game itself_
161
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* ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    54
|| sound=true || Boolean || If sound effects should be played  in-game ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    55
|| music=true || Boolean || If background music should be played in-game ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    56
|| volume=100 || Integer || Volume level (in percent) of sound effects and music ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    57
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    58
=== {{{[net]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    59
_Online and LAN settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    60
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    61
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    62
|| nick=username || String || Username/nickname used for online play, or promt the user when first connecting if left blank ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    63
|| passwordhash=d41d8cd98f00b204e9800998ecf8427e || String || Hash of password used for online play ||
875
1da68c22bb10 ConfigurationFiles: fix passwordlength
Wuzzy
parents: 874
diff changeset
    64
|| passwordlength=0 || Integer || Currently unused ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    65
|| savepassword=true || Boolean || If true, password will be saved ||
874
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    66
|| ip=10.0.0.0 || String || Default IP address or hostname when connecting to a LAN server ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    67
|| 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
    68
|| 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
    69
|| 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
    70
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    71
=== {{{[fps]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    72
_Frames per second settings_
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* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    75
|| 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
    76
|| 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
    77
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    78
=== {{{[proxy]}}} ===
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    79
_Proxy settings_
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    80
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    81
|| *Setting* || *Type* || *Description* ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    82
|| type=0 || Integer || Proxy type. 0: no proxy, 1: system proxy, 2: SOCKS5 proxy, 3: HTTP proxy. The following settings are ignored if the proxy type is 0 or 1. ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    83
|| host || String || Hostname or IP adress of proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    84
|| port || Integer || Port number of proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    85
|| login || String || User name to login to the proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    86
|| password || String || Password (in clear text) to login to the proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    87
874
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    88
=== {{{[videorec]}}} ===
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    89
_Video recording settings_
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    90
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    91
|| *Setting* || *Type* || *Description* ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    92
|| format=mp4 || String || Container format (the file format of the resulting file) ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    93
|| videocodec || String || Video codec ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    94
|| audiocodec || String || Audio codec ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    95
|| framerate || Integer || Frame rate in frames per second ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    96
|| bitrate || Integer || The bit rate in 1000 bytes per second ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    97
|| width || Integer || Video width ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    98
|| height || Integer || Video height ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    99
|| usegameres || Boolean || If true, use the game resolution and ignore the width and height settings ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   100
|| audio || Boolean || Whether to use audio ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   101
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   102
=== {{{[colors]}}} ===
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   103
Setup 9 team colors here, the setting names are from `color0` to `color8`. The values are 3-byte hexadecimal numbers in RGB notation with “#” prefixed.
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   104
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   105
|| *Setting* || *Default* ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   106
|| color0 || #ff0204 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   107
|| color1 || #4980c1 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   108
|| color2 || #1de6ba ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   109
|| color3 || #b541ef ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   110
|| color4 || #e55bb0 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   111
|| color5 || #20bf00 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   112
|| color6 || #fe8b0e ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   113
|| color7 || #874b06 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   114
|| color8 || #ffff01 ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
   115
876
0977e2d2fdcd ConfigurationFiles: fix [Binds]
Wuzzy
parents: 875
diff changeset
   116
=== {{{[Binds]}}} ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   117
This section defines the global key bindings. They can be overwritten by teams.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   118
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   119
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
   120
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   121
==== Actions ====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   122
|| *Setting* || *Description* ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   123
|| %2Bup || Up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   124
|| %2Bleft || Left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   125
|| %2Bright || Right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   126
|| %2Bdown || Down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   127
|| %2Bprecise || Precise ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   128
|| ljump || Long jump ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   129
|| hjump || High jump ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   130
|| switch || Switch hog ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   131
|| ammomenu || Ammo menu ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   132
|| slot%201 || Slot 1 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   133
|| slot%202 || Slot 2 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   134
|| slot%203 || Slot 3 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   135
|| slot%204 || Slot 4 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   136
|| slot%205 || Slot 5 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   137
|| slot%206 || Slot 6 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   138
|| slot%207 || Slot 7 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   139
|| slot%208 || Slot 8 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   140
|| slot%209 || Slot 9 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   141
|| slot%20%3A || Slot 10 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   142
|| timer%201 || Timer: 1 second ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   143
|| timer%202 || Timer: 2 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   144
|| timer%203 || Timer: 3 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   145
|| timer%204 || Timer: 4 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   146
|| timer%205 || Timer: 5 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   147
|| %2Battack || Attack ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   148
|| put || Place hedgehog or select target ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   149
|| findhh || Automatic camera / find hedgehog ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   150
|| %2Bcur_u || Move camera or cursor up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   151
|| %2Bcur_l || Move camera or cursor left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   152
|| %2Bcur_r || Move camera or cursor right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   153
|| %2Bcur_d || Move camera or cursor down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   154
|| zoomin || Zoom in ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   155
|| zoomout || Zoom out ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   156
|| zoomreset || Reset zoom ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   157
|| chat || Open chat input ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   158
|| history || Toggle chat history ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   159
|| pause || Toggle pause ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   160
|| quit || Quit ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   161
|| confirm || Confirm ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   162
|| %2Bvoldown || Raise volume ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   163
|| %2Bvolup || Lower volume ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   164
|| mute || Mute ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   165
|| fullscr || Toggle window mode (window/fullscreen) ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   166
|| capture || Take screenshot ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   167
|| %2Bspeedup || Increase demo replay speed ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   168
|| rotmask || Cycle tags above hedgehogs ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   169
|| record || Record video ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   170
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   171
==== Key codes ====
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   172
===== Keyboard =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   173
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
   174
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   175
The key name is constructed as follows:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   176
677
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   177
 * Take the name from the “Key Name” column of the aforementioned webpage
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   178
 * Convert it to lower-case
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   179
 * Replace spaces with underscores
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   180
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   181
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   182
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   183
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   184
|| `a` || A ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   185
|| `f1` || F1 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   186
|| `shift_left` || Left shift key ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   187
|| `space` || Space bar ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   188
|| `tab` || Tabulator ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   189
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   190
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   191
===== Mouse =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   192
The codes for the mouse are as follows:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   193
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   194
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   195
|| `mousel` || Left mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   196
|| `mousem` || Middle mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   197
|| `mouser` || Right mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   198
|| `wheelup` || Mouse wheel up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   199
|| `wheeldown` || Mouse wheel down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   200
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   201
===== Controller/Gamepad/Joystick =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   202
Controllers, gamepads and joysticks are written in a somewhat cryptic syntax.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   203
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   204
====== Buttons ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   205
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   206
Syntax: `jJbB`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   207
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   208
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   209
 * `A`: Button ID beginning with 0
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   210
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   211
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   212
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   213
|| `j0b0` || First controller, first button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   214
|| `j0b1` || First controller, second button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   215
|| `j1b2` || Second controller, third button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   216
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   217
====== Axes ======
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
Syntax: `jJaAD`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   220
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   221
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   222
 * `A`: Axis 
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   223
 * `D`: Axis direction. One of the following letters:
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   224
  * `u`: positive (“up”)
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   225
  * `d`: negative (“down”)
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   226
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   227
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   228
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   229
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   230
|| `j0a0u` || First controller, first axis up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   231
|| `j0a1d` || First controller, second axis down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   232
|| `j1a1d` || Second controller, second axis down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   233
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   234
====== Hats/D-pads ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   235
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   236
Syntax: `jJhHD`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   237
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   238
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   239
 * `A`: D-pad ID 
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   240
 * `D`: Direction, it is one of 4 letters:
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   241
  * `u`: up
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   242
  * `r`: right
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   243
  * `d`: down
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   244
  * `l`: left
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   245
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   246
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   247
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   248
|| `j0h0u` || First controller, first D-pad up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   249
|| `j0h1l` || First controller, second D-pad left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   250
|| `j1h1r` || Second controller, second D-pad right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   251
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   252
== `weapons.ini` ==
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   253
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   254
=== {{{[General]}}} ===
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   255
_List of weapon settings as key-value pairs, each with a string name and integer value_
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   256
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   257
|| *Setting* || *Type* || *Description* ||
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   258
|| Default=93919...11101 || Integer || Which weapons are allowed in the default mode ||
674
e3f2f797fbd0 Syntax fix (2)
Wuzzy
parents: 673
diff changeset
   259
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   260
== `schemes.ini` ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   261
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   262
=== {{{[schemes]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   263
_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
   264
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   265
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   266
|| size=1 || Integer || Number of custom scheme settings ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   267
|| 1\name=new || String || Name of scheme ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   268
|| 1\fortsmode=false || Boolean || If forts are enabled ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   269
|| 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
   270
|| 1\solidland=false || Boolean || If land is indestructible ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   271
|| 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
   272
|| 1\lowgrav=false || Boolean || If gravity is lowered ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   273
|| 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
   274
|| 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
   275
|| 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
   276
|| 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
   277
|| 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
   278
|| 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
   279
|| 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
   280
|| 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
   281
|| 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
   282
|| 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
   283
|| 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
   284
|| 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
   285
|| 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
   286
|| 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
   287
|| 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
   288
|| 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
   289
|| 1\disablewind=false || Boolean || If wind is disabled ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   290
|| 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
   291
|| 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
   292
|| 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
   293
|| 1\damagefactor=100 || Integer || Percentage of damage dealt ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   294
|| 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
   295
|| 1\health=100 || Integer || The initial health of the hogs ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   296
|| 1\suddendeath=15 || Integer || Turns before "Sudden Death" mode begins ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   297
|| 1\caseprobability=5 || Integer || Number of turns between cases drops ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   298
|| 1\minestime=3 || Integer || Seconds before mines explode ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   299
|| 1\minesnum=4 || Integer || Number of mines on a level ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   300
|| 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
   301
|| 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
   302
|| 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
   303
|| 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
   304
|| 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
   305
|| 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
   306
|| 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
   307
|| 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
   308
|| 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
   309
|| 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
   310
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   311
== `TeamName.hwt` ==
671
f99b16de1060 Better description of TeamName.hwt
Wuzzy
parents: 644
diff changeset
   312
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
   313
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   314
=== {{{[Team]}}} ===
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   315
_General team settings_
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   316
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   317
|| *Setting* || *Type* || *Description* ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   318
|| Name=!TeamName || String || Name of team ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   319
|| 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
   320
|| 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
   321
|| Voicepack=Default || String || Sounds used for hog voice ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   322
|| 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
   323
|| 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
   324
|| 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
   325
|| Wins=0 || Integer || Number of rounds won with team _(Currently unused)_ ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   326
|| !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
   327
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   328
=== {{{[Hedgehog0]}}} - {{{[Hedgehog7]}}} ===
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   329
_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
   330
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   331
|| *Setting* || *Type* || *Description* ||
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   332
|| Name=Hedgehog Name || String || Name of hog ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   333
|| 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
   334
|| 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
   335
|| 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
   336
|| 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
   337
|| Suicides=0 || Integer || Suicides comitted by hog _(Currently unused)_ ||
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   338
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   339
=== {{{[Binds]}}} ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   340
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
   341
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   342
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
   343
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   344
==== Values ====
643
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   345
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
   346
877
64b2785dc598 ConfigurationFiles: minor fix
Wuzzy
parents: 876
diff changeset
   347
Regarding other keys: See [Binds] of settings.ini.
643
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   348
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   349
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   350
=== {{{[Campaign%20<CAMPAIGN_NAME>]}}} ===
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   351
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
   352
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   353
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
   354
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   355
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, and since 0.9.23, also to determine which missions and campaigns have been completed.
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   356
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   357
For linear campaigns, the variables `Progress` and `Won` are used.
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   358
For non-linear campaigns, the variables `UnlockedMissions`, `MissionX`, `MissionXWon` and `Won` are used.
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   359
The variables should not be mixed up.
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   360
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   361
Since Hedgewars 0.9.23, completed missions and campaigns get a check mark in the campaign screen.
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   362
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   363
|| *Setting* || *Type* || *Description* ||
928
20cb05132905 ConfigurationFiles: linear campaign clarify
Wuzzy
parents: 927
diff changeset
   364
|| `Progress` || Integer || Since version 0.9.23, this variable stands for the number of completed missions in a linear campaign, starting with mission 1. For each completed mission, the next one gets unlocked. Previous versions have a slightly trickier definition: 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. ||
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   365
|| `UnlockedMissions` || Integer || 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. ||
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   366
|| `MissionX` || Integer || E.g. `Mission1`, `Mission2`, etc. Contains the `campaign.ini` ID of the `X`th unlocked mission, must be used together with `UnlockedMissions` ||
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   367
|| `MissionXWon` || Boolean || Since 0.9.23. E.g. `Mission1Won`, `Mission2Won`, etc. If `true`, the mission with the number `X` in `campaign.ini` has been completed. ||
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   368
|| `Won` || Boolean || Since 0.9.23. If `true`, the team has completed the campaign. Note that campaign victory is completely seperate from mission victory, so this setting must be set seperately. ||
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   369
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   370
By default, the first mission (Mission 1 in `campaign.ini`) is available.
581
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   371
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   372
==== Examples ====
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   373
Simple campaign with 10 missions, missions 1-5 are available and missions 1-4 count as completed:
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   374
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   375
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   376
[Campaign%20Simple_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   377
Progress=4
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   378
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   379
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   380
Simple 0.9.23 campaign with 6 missions. This campaign and all its missions have been unlocked and completed:
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   381
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   382
{{{
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   383
[Campaign%20Simple_Campaign_2]
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   384
Progress=6
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   385
Won=true
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   386
}}}
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   387
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   388
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   389
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
   390
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   391
[Campaign%20Complex_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   392
UnlockedMissions=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   393
Mission1=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   394
Mission2=7
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   395
Mission3=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   396
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   397
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   398
Another campaign with some custom campaign variables:
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   399
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   400
[Campaign%20Another_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   401
Progress=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   402
MyCustomVariable=54
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   403
MyCustomString=Hedgewars
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   404
}}}