ConfigurationFiles.wiki
author Wuzzy
Sat, 07 Dec 2019 11:23:22 +0000
changeset 2123 7df4304efaef
parent 2094 255295dfbd3d
permissions -rw-r--r--
LuaGears: Explain heResurrected better
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 =
2094
255295dfbd3d ConfigurationFiles: add newline
Wuzzy
parents: 2077
diff changeset
     5
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
     6
== Introduction ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     7
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     8
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
     9
759
357ba2e4ea16 ConfigurationFiles: Fix max_depth parameter
Wuzzy
parents: 758
diff changeset
    10
<wiki:toc max_depth="2" />
166
26202b9ff10d Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 165
diff changeset
    11
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
    12
== `settings.ini` ==
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    13
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    14
=== {{{[video]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    15
_Graphics rendering settings, back-end (engine)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    16
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    17
|| *Setting* || *Type* || *Description* ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    18
|| fullscreenResolution=1280x768 || String || Screen resolution the game is rendered when using fullscreen mode ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    19
|| windowedWidth=1280 || Integer || Window width when using window mode ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    20
|| 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
    21
|| fullscreen=false || Boolean || If the game is rendered in fullscreen ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    22
|| 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
    23
|| 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
    24
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    25
=== {{{[frontend]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    26
_Graphics and sound settings, front-end (GUI)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    27
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    28
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    29
|| effects=true || Boolean || If game effects are displayed ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    30
|| 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
    31
|| width=800 || Integer || Width of the game window ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    32
|| height=600 || Integer || Height of the game window ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    33
|| sound=true || Boolean || If sounds are being played in the frontend ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    34
|| 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
    35
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    36
=== {{{[misc]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    37
_Miscellaneous settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    38
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    39
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    40
|| 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
    41
|| 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
    42
|| 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
    43
|| 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
    44
|| teamtag || Boolean || Whether to show the team name above hedgehogs by default ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    45
|| hogtag || Boolean || Whether to show the hog name above hedgehogs by default ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    46
|| healthtag || Boolean || Whether to show the health above hedgehogs by default ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    47
|| 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
    48
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    49
=== {{{[audio]}}} ===
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    50
_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
    51
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    52
|| *Setting* || *Type* || *Description* ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    53
|| sound=true || Boolean || If sound effects should be played  in-game ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    54
|| music=true || Boolean || If background music should be played in-game ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    55
|| 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
    56
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    57
=== {{{[net]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    58
_Online and LAN settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    59
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    60
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    61
|| 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
    62
|| passwordhash=d41d8cd98f00b204e9800998ecf8427e || String || Hash of password used for online play ||
875
1da68c22bb10 ConfigurationFiles: fix passwordlength
Wuzzy
parents: 874
diff changeset
    63
|| passwordlength=0 || Integer || Currently unused ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    64
|| savepassword=true || Boolean || If true, password will be saved ||
874
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    65
|| 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
    66
|| 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
    67
|| 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
    68
|| 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
    69
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
    70
=== {{{[fps]}}} ===
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    71
_Frames per second settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    72
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    73
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    74
|| 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
    75
|| 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
    76
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    77
=== {{{[proxy]}}} ===
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    78
_Proxy settings_
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    79
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    80
|| *Setting* || *Type* || *Description* ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    81
|| 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
    82
|| host || String || Hostname or IP adress of proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    83
|| port || Integer || Port number of proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    84
|| login || String || User name to login to the proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    85
|| password || String || Password (in clear text) to login to the proxy ||
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
    86
874
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    87
=== {{{[videorec]}}} ===
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    88
_Video recording settings_
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    89
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    90
|| *Setting* || *Type* || *Description* ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    91
|| format=mp4 || String || Container format (the file format of the resulting file) ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    92
|| videocodec || String || Video codec ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    93
|| audiocodec || String || Audio codec ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    94
|| framerate || Integer || Frame rate in frames per second ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    95
|| bitrate || Integer || The bit rate in 1000 bytes per second ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    96
|| width || Integer || Video width ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    97
|| height || Integer || Video height ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
    98
|| 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
    99
|| audio || Boolean || Whether to use audio ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   100
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   101
=== {{{[colors]}}} ===
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   102
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
   103
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   104
|| *Setting* || *Default* ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   105
|| color0 || #ff0204 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   106
|| color1 || #4980c1 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   107
|| color2 || #1de6ba ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   108
|| color3 || #b541ef ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   109
|| color4 || #e55bb0 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   110
|| color5 || #20bf00 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   111
|| color6 || #fe8b0e ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   112
|| color7 || #874b06 ||
fbdbce68efd8 ConfigurationFiles: Add more settings.ini stuff
Wuzzy
parents: 873
diff changeset
   113
|| color8 || #ffff01 ||
873
5da391a0d8ac ConfigurationFiles: Add some settings stuff
Wuzzy
parents: 872
diff changeset
   114
876
0977e2d2fdcd ConfigurationFiles: fix [Binds]
Wuzzy
parents: 875
diff changeset
   115
=== {{{[Binds]}}} ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   116
This section defines the global key bindings. They can be overwritten by teams.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   117
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   118
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
   119
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   120
==== Actions ====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   121
|| *Setting* || *Description* ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   122
|| %2Bup || Up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   123
|| %2Bleft || Left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   124
|| %2Bright || Right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   125
|| %2Bdown || Down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   126
|| %2Bprecise || Precise ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   127
|| ljump || Long jump ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   128
|| hjump || High jump ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   129
|| switch || Switch hog ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   130
|| ammomenu || Ammo menu ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   131
|| slot%201 || Slot 1 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   132
|| slot%202 || Slot 2 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   133
|| slot%203 || Slot 3 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   134
|| slot%204 || Slot 4 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   135
|| slot%205 || Slot 5 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   136
|| slot%206 || Slot 6 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   137
|| slot%207 || Slot 7 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   138
|| slot%208 || Slot 8 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   139
|| slot%209 || Slot 9 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   140
|| slot%20%3A || Slot 10 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   141
|| timer%201 || Timer: 1 second ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   142
|| timer%202 || Timer: 2 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   143
|| timer%203 || Timer: 3 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   144
|| timer%204 || Timer: 4 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   145
|| timer%205 || Timer: 5 seconds ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   146
|| %2Battack || Attack ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   147
|| put || Place hedgehog or select target ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   148
|| findhh || Automatic camera / find hedgehog ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   149
|| %2Bcur_u || Move camera or cursor up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   150
|| %2Bcur_l || Move camera or cursor left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   151
|| %2Bcur_r || Move camera or cursor right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   152
|| %2Bcur_d || Move camera or cursor down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   153
|| zoomin || Zoom in ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   154
|| zoomout || Zoom out ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   155
|| zoomreset || Reset zoom ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   156
|| chat || Open chat input ||
1525
7bef7b6338e2 ConfigurationFiles: rename team chat to clan chat
Wuzzy
parents: 1524
diff changeset
   157
|| chat%20team || Open clan chat input ||
672
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 ||
1045
54979ae0e5ac ConfigurationFiles: Update rotmask explanation
Wuzzy
parents: 928
diff changeset
   168
|| rotmask || Toggle team bars ||
1405
102a40ccc9f3 ConfigurationFiles: add new controls
Wuzzy
parents: 1404
diff changeset
   169
|| rottags || Toggle hedgehog tags ||
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   170
|| record || Record video ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   171
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   172
==== Key codes ====
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   173
===== Keyboard =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   174
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
   175
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   176
The key name is constructed as follows:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   177
677
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   178
 * Take the name from the “Key Name” column of the aforementioned webpage
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   179
 * Convert it to lower-case
28c2e00ed2b0 Fix more bullets
Wuzzy
parents: 676
diff changeset
   180
 * Replace spaces with underscores
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   181
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   182
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   183
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   184
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   185
|| `a` || A ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   186
|| `f1` || F1 ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   187
|| `shift_left` || Left shift key ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   188
|| `space` || Space bar ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   189
|| `tab` || Tabulator ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   190
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   191
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   192
===== Mouse =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   193
The codes for the mouse are as follows:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   194
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   195
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   196
|| `mousel` || Left mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   197
|| `mousem` || Middle mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   198
|| `mouser` || Right mouse button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   199
|| `wheelup` || Mouse wheel up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   200
|| `wheeldown` || Mouse wheel down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   201
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   202
===== Controller/Gamepad/Joystick =====
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   203
Controllers, gamepads and joysticks are written in a somewhat cryptic syntax.
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   204
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   205
====== Buttons ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   206
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   207
Syntax: `jJbB`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   208
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   209
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   210
 * `A`: Button ID beginning with 0
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   211
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   212
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   213
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   214
|| `j0b0` || First controller, first button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   215
|| `j0b1` || First controller, second button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   216
|| `j1b2` || Second controller, third button ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   217
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   218
====== Axes ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   219
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   220
Syntax: `jJaAD`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   221
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   222
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   223
 * `A`: Axis 
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   224
 * `D`: Axis direction. One of the following letters:
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   225
  * `u`: positive (“up”)
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   226
  * `d`: negative (“down”)
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   227
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   228
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   229
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   230
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   231
|| `j0a0u` || First controller, first axis up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   232
|| `j0a1d` || First controller, second axis down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   233
|| `j1a1d` || Second controller, second axis down ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   234
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   235
====== Hats/D-pads ======
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   236
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   237
Syntax: `jJhHD`
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   238
676
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   239
 * `J`: Controller ID beginning with 0
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   240
 * `A`: D-pad ID 
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   241
 * `D`: Direction, it is one of 4 letters:
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   242
  * `u`: up
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   243
  * `r`: right
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   244
  * `d`: down
9b0d8d0ab5f9 Fix bullet points
Wuzzy
parents: 675
diff changeset
   245
  * `l`: left
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   246
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   247
Examples:
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   248
|| *Code* || Description ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   249
|| `j0h0u` || First controller, first D-pad up ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   250
|| `j0h1l` || First controller, second D-pad left ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   251
|| `j1h1r` || Second controller, second D-pad right ||
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   252
1401
ce7a84ad72bf ConfigurationFiles: fix file suffix
Wuzzy
parents: 1400
diff changeset
   253
== `Schemes/Game/<SchemeName>.hwg` ==
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   254
A game scheme. Each game scheme has its own file. `<SchemeName>` is the name of the scheme. Each game scheme setting is stored as a key-value pair, one setting per line:
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   255
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   256
|| *Setting* || *Type* || *Description* ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   257
|| switchhog=false || Boolean || If free hog switching is enabled on turn start ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   258
|| divteams=false || Boolean || If teams start at the opposite side of the terrain ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   259
|| solidland=false || Boolean || If land is indestructible ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   260
|| border=false || Boolean || If an insestructible border is added around the map ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   261
|| lowgrav=false || Boolean || If gravity is lowered ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   262
|| laser=false || Boolean || If aiming is assisted with laser sights ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   263
|| invulnerability=false || Boolean || If hogs have a personal forcefield ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   264
|| resethealth=false || Boolean || If living hogs' health is reset to 100 at end of round ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   265
|| vampiric=false || Boolean || If hogs gain life equal to 80 percent of the damage they deal ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   266
|| karma=false || Boolean || If hogs lose life equal to the damage they deal ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   267
|| artillery=false || Boolean || If hogs are unable to move ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   268
|| randomorder=true || Boolean || If turn order is generated randomly ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   269
|| king=false || Boolean || If a chess-like king is used ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   270
|| placehog=false || Boolean || If players take turns placing their hogs before the start of a game ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   271
|| sharedammo=false || Boolean || If ammo is shared between all teams of the same color ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   272
|| disablegirders=false || Boolean || If girders are removed from randomly-generated maps ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   273
|| disablelandobjects=false || Boolean || If land objects are removed from randomly-generated maps ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   274
|| aisurvival=false || Boolean || If AI hogs respawn on death ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   275
|| infattack=false || Boolean || If hogs can attack an unlimited number of times each turn ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   276
|| resetweps=false || Boolean || If weapons are reset at end of each turn ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   277
|| perhogammo=false || Boolean || If each hog has seperate ammo ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   278
|| disablewind=false || Boolean || If wind is disabled ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   279
|| morewind=false || Boolean || If wind is much stronger then usually ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   280
|| tagteam=false || Boolean || If players in a team share time on each turn ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   281
|| bottomborder=false || Boolean || If an indestructible border is added at the bottom of the map ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   282
|| damagefactor=100 || Integer || Percentage of damage dealt ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   283
|| turntime=45 || Integer || Maximum time in seconds of each turn ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   284
|| health=100 || Integer || The initial health of the hogs ||
1576
c0026d20b468 ConfigurationFiles: fix typo
Wuzzy
parents: 1575
diff changeset
   285
|| suddendeath=15 || Integer || Number of rounds to play until Sudden Death begins, _after the first round was played_. 0 = SD starts in 2nd round ||
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   286
|| caseprobability=5 || Integer || Number of turns between cases drops ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   287
|| minestime=3 || Integer || Seconds before mines explode ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   288
|| minesnum=4 || Integer || Number of mines on a level ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   289
|| minedudpct=0 || Integer || Percentage chance of each mine being a dud ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   290
|| explosives=2 || Integer || Number of explosives on a level ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   291
|| healthprobability=35 || Integer || Percentage chance of each crate being a health crate ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   292
|| healthcaseamount=25 || Integer || Amount of life restored by each health crate ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   293
|| waterrise=47 || Integer || Number of pixels the water rises each turn in "Sudden Death" mode ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   294
|| healthdecrease=5 || Integer || Damage dealth each turn to hogs in water during "Sudden Death" mode ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   295
|| ropepct=100 || Integer || Maximum length of rope as a percentage ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   296
|| getawaytime=100 || Integer || Time you have to get away from an explosive after arming it, as a percentage ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   297
|| 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. ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   298
|| 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. ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   299
1401
ce7a84ad72bf ConfigurationFiles: fix file suffix
Wuzzy
parents: 1400
diff changeset
   300
== `Schemes/Ammo/<SchemeName>.hwa` ==
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   301
A weapon scheme. `<SchemeName>` is the name of this weapon scheme. This file contains a long sequence of numbers between `0` to `9` to configure all weapon settings.
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   302
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   303
The number string has 4 equally long sections, in this order:
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   304
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   305
 * Start ammo (9 = infinite)
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   306
 * Crate probability (higher = more)
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   307
 * Ammo in crate
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   308
 * Delay
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   309
1406
29d47056785f ConfigurationFiles: add link
Wuzzy
parents: 1405
diff changeset
   310
In each section, each number represents one weapon. The order of these weapons is noted in the source code file `weapons.h` ([https://hg.hedgewars.org/hedgewars/file/tip/QTfrontend/weapons.h#l24]). This means the first number of a section is for the grenade, followed by the cluster bomb, then bazooka, and so on.
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   311
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   312
== `schemes.ini` ==
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   313
Legacy file for game schemes for version 0.9.23 and older. Since 0.9.24, this file is no longer actively used, it is now only used to import schemes to the new format when the `Schemes/Game/` directory has not been created yet.
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   314
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   315
=== {{{[schemes]}}} ===
1403
17f1cb8c4318 ConfigurationFiles: fix cursive
Wuzzy
parents: 1402
diff changeset
   316
List of custom scheme settings as key-value pairs, each with a key of "index number of scheme backslash setting name". The only exception is `size` which holds the number of game schemes in this file.
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   317
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   318
|| *Setting* || *Type* || *Description* ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   319
|| size=1 || Integer || Number of custom scheme settings ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   320
|| 1\name=new || String || Name of scheme no. 1 ||
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   321
|| 1\fortsmode=false || Boolean || Whether forts are used in scheme no. 1. This is no longer used since 0.9.23 ||
1404
c39caed7af8f ConfigurationFiles: Edited via web interface
Wuzzy
parents: 1403
diff changeset
   322
|| 1\<setting>=value || _See above_ || A setting of scheme no. 1. `<setting>` is any of the game scheme settings listed above in the new game scheme format ||
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   323
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   324
== `weapons.ini` ==
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   325
Legacy file for weapon schemes for version 0.9.23 and older. Since 0.9.24, this file is no longer actively used, it is now only used to import weapon schemes to the new format when the `Schemes/Ammo/` directory has not been created yet.
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   326
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   327
=== {{{[General]}}} ===
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   328
_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
   329
872
8aa46333bfe2 ConfigurationFiles: merge hedgewars.ini with settings.ini
Wuzzy
parents: 759
diff changeset
   330
|| *Setting* || *Type* || *Description* ||
1400
7e69fc304d43 ConfigurationFiles: Update for new scheme forma
Wuzzy
parents: 1399
diff changeset
   331
|| `<Scheme name>`=93919...11101 || Integer || Weapon settings. `<Scheme name>` is the name of the scheme. The number string has the same meaning as in the new ammo scheme file ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   332
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   333
== `TeamName.hwt` ==
671
f99b16de1060 Better description of TeamName.hwt
Wuzzy
parents: 644
diff changeset
   334
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
   335
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   336
=== {{{[Team]}}} ===
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   337
_General team settings_
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   338
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   339
|| *Setting* || *Type* || *Description* ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   340
|| Name=!TeamName || String || Name of team ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   341
|| 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
   342
|| 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
   343
|| Voicepack=Default || String || Sounds used for hog voice ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   344
|| 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
   345
|| Difficulty=0 || Integer || Diffuculty of AI (1-5, 1 = most difficult), or human if 0 ||
1524
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   346
|| Rounds=0 || Integer || _Unused_ ||
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   347
|| Wins=0 || Integer || _Unused_ ||
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   348
|| !CampaignProgress=0 || Integer || _Unused_ ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   349
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   350
=== {{{[Hedgehog0]}}} - {{{[Hedgehog7]}}} ===
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   351
_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
   352
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   353
|| *Setting* || *Type* || *Description* ||
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   354
|| Name=Hedgehog Name || String || Name of hog ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   355
|| Hat=!NoHat || String || Type of hat used by hog ||
1524
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   356
|| Rounds=0 || Integer || _Unused_ ||
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   357
|| Kills=0 || Integer || _Unused_ ||
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   358
|| Deaths=0 || Integer || _Unused_ ||
e2ee3b9b0084 ConfigurationFiles: Simplify unused team vars
Wuzzy
parents: 1407
diff changeset
   359
|| Suicides=0 || Integer || _Unused_ ||
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   360
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   361
=== {{{[Binds]}}} ===
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   362
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
   363
672
11a785201118 Continue documentation of key binds
Wuzzy
parents: 671
diff changeset
   364
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
   365
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   366
==== Values ====
643
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   367
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
   368
1835
0123940e6aa5 ConfigurationFiles: Fix Binds link
Wuzzy
parents: 1722
diff changeset
   369
Regarding other keys: See the [ConfigurationFiles#%5BBinds%5D “Binds” section of settings.ini].
643
1d8279176ba6 Add list of team key bindings
Wuzzy
parents: 582
diff changeset
   370
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   371
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   372
=== {{{[Campaign%20<CAMPAIGN_NAME>]}}} ===
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   373
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
   374
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   375
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
   376
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2074
diff changeset
   377
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 to determine which missions and campaigns have been completed.
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   378
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   379
For linear campaigns, the variables `Progress` and `Won` are used.
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   380
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
   381
The variables should not be mixed up.
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   382
2074
de9ad743666e ConfigurationFiles: Update Progress
Wuzzy
parents: 1944
diff changeset
   383
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
   384
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   385
|| *Setting* || *Type* || *Description* ||
2074
de9ad743666e ConfigurationFiles: Update Progress
Wuzzy
parents: 1944
diff changeset
   386
|| `Progress` || Integer || 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. 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
   387
|| `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
   388
|| `MissionX` || Integer || E.g. `Mission1`, `Mission2`, etc. Contains the `campaign.ini` ID of the `X`th unlocked mission, must be used together with `UnlockedMissions` ||
1721
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   389
|| `MissionXWon` || Boolean || E.g. `Mission1Won`, `Mission2Won`, etc. If `true`, the mission with the number `X` in `campaign.ini` has been completed. ||
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   390
|| `Won` || Boolean || If `true`, the team has completed the campaign. Note that campaign victory is completely separate from mission victory, so this setting must be set seperately. ||
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   391
1944
3792ec13b5e0 ConfigurationFiles: fix UnlockedMission typo
Wuzzy
parents: 1943
diff changeset
   392
If neither `Progress` nor `UnlockedMissions` is set (which is the case for new teams), only 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
   393
758
ecdd12db8754 ConfigurationFiles: Add title, fix header levels, simplify TOC
Wuzzy
parents: 677
diff changeset
   394
==== Examples ====
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   395
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
   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
[Campaign%20Simple_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   399
Progress=4
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   400
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   401
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2074
diff changeset
   402
Simple campaign with 6 missions. This campaign and all its missions have been unlocked and completed:
927
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   403
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   404
{{{
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   405
[Campaign%20Simple_Campaign_2]
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   406
Progress=6
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   407
Won=true
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   408
}}}
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   409
726d9a6042ae ConfigurationFiles: Update team info for new campaign vars
Wuzzy
parents: 877
diff changeset
   410
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   411
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
   412
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   413
[Campaign%20Complex_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   414
UnlockedMissions=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   415
Mission1=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   416
Mission2=7
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   417
Mission3=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   418
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   419
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   420
Another campaign with some custom campaign variables:
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   421
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   422
[Campaign%20Another_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   423
Progress=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   424
MyCustomVariable=54
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   425
MyCustomString=Hedgewars
1721
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   426
}}}
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   427
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   428
=== {{{[Mission%20<MISSION_NAME>]}}} ===
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   429
This section stores mission variables. Mission variables are very similar to campaign variables, but they are for single missions (training/challenge/scenario) that are not part of a campaign. Replace “`<MISSION_NAME>` with the file name of the mission.
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   430
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   431
Like campaign variables, mission variables are stored on a key-value basis. You can choose custom names but there are also a few special key names with a special meaning.
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   432
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   433
`Won` is to mark victory and it's often useful to be used together with `onGameResult`. The other special keys are to store challenge records. Use these only when they make sense.
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   434
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   435
|| *Setting* || *Type* || *Description* ||
d79a66ca382e ConfigurationFiles: Add mission var section
Wuzzy
parents: 1576
diff changeset
   436
|| `Won` || Boolean || If `true`, the team has completed the mission. ||
1722
64d86e73127d ConfigurationFiles: Clarify Mission
Wuzzy
parents: 1721
diff changeset
   437
|| `Highscore` || Integer || Team's best score in this mission, where higher = better ||
64d86e73127d ConfigurationFiles: Clarify Mission
Wuzzy
parents: 1721
diff changeset
   438
|| `Lowscore` || Integer || Team's best score in this mission, where lower = better ||
1943
a6b601c51fc8 ConfigurationFiles: Fix typos
Wuzzy
parents: 1835
diff changeset
   439
|| `TimeRecord` || Integer || Team's best time (in milliseconds) in this mission, where lower = better ||
a6b601c51fc8 ConfigurationFiles: Fix typos
Wuzzy
parents: 1835
diff changeset
   440
|| `TimeRecordHigh` || Integer || Team's best time (in milliseconds) in this mission, where higher = better ||
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2074
diff changeset
   441
|| `AccuracyRecord` || Integer || Team's highest accuracy in this mission, in percent ||