ConfigurationFiles.wiki
author Wuzzy
Thu, 10 Sep 2015 02:03:47 +0000
changeset 629 d4ccc5e79e58
parent 582 96dd549eeead
child 643 1d8279176ba6
permissions -rw-r--r--
fix link?
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
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     4
= Introduction =
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     5
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
     6
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
     7
166
26202b9ff10d Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 165
diff changeset
     8
<wiki:toc />
26202b9ff10d Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 165
diff changeset
     9
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
    10
= `Hedgewars.ini` =
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    11
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    12
== {{{[video]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    13
_Graphics rendering settings, back-end (engine)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    14
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    15
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    16
|| resolution=1280x768 || String || Screen resolution the game is rendered at ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    17
|| fullscreen=false || Boolean || If the game is rendered in fullscreen ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    18
|| quality=5 || Integer || Quality of game rendering ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    19
|| 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
    20
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    21
== {{{[frontend]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    22
_Graphics and sound settings, front-end (GUI)_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    23
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    24
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    25
|| effects=true || Boolean || If game effects are displayed ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    26
|| 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
    27
|| width=800 || Integer || Width of the game window ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    28
|| height=600 || Integer || Height of the game window ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    29
|| sound=true || Boolean || If sounds are being played ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    30
|| music=true || Boolean || If background music is being played ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    31
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    32
== {{{[misc]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    33
_Miscellaneous settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    34
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    35
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    36
|| 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
    37
|| 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
    38
|| 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
    39
|| locale=en_US || String || Language used in game in the format "ISO 639-1 Code underscore ISO 3166-1 alpha-2 Code", or system default if left blank ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    40
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    41
== {{{[audio]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    42
_Sound rendering settings, back-end_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    43
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    44
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    45
|| sound=true || Boolean || If sound effects should be rendered ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    46
|| music=true || Boolean || If background music should be rendered ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    47
|| volume=100 || Integer || Volume level of sound effects and music rendering ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    48
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    49
== {{{[net]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    50
_Online and LAN settings_
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* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    53
|| nick=username || String || Username/nickname used for online play, or promt the user when first connecting if left blank ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
    54
|| passwordhash=@!ByteArray(d41d8cd98f00b204e9800998ecf8427e) || Byte array || Hash of password used for online play ||
161
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    55
|| passwordlength=0 || Integer || Lenght of unhashed password string ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    56
|| ip=10.0.0.0 || String || Default IP-address when connecting to a LAN server, stored in human-readable dot-notation ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    57
|| 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
    58
|| 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
    59
|| 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
    60
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    61
== {{{[fps]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    62
_Frames per second settings_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    63
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    64
|| *Setting* || *Type* || *Description* ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    65
|| 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
    66
|| 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
    67
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    68
= Weapons.ini: =
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    69
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    70
== {{{[General]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    71
_List of weapon settings as key-value pairs, each with a string name and integer value_
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    72
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    73
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    74
|| Default=93919...11101 || Integer || Which weapons are allowed in the default mode ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    75
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    76
= Schemes.ini: =
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    77
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    78
== {{{[schemes]}}} ==
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    79
_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
    80
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    81
|| *Setting* || *Type* || *Description* ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    82
|| size=1 || Integer || Number of custom scheme settings ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
    83
|| 1\name=new || String || Name of scheme ||
162
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    84
|| 1\fortsmode=false || Boolean || If forts are enabled ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    85
|| 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
    86
|| 1\solidland=false || Boolean || If land is indestructible ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    87
|| 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
    88
|| 1\lowgrav=false || Boolean || If gravity is lowered ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
    89
|| 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
    90
|| 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
    91
|| 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
    92
|| 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
    93
|| 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
    94
|| 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
    95
|| 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
    96
|| 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
    97
|| 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
    98
|| 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
    99
|| 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
   100
|| 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
   101
|| 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
   102
|| 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
   103
|| 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
   104
|| 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
   105
|| 1\disablewind=false || Boolean || If wind is disabled ||
d51550b90632 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 161
diff changeset
   106
|| 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
   107
|| 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
   108
|| 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
   109
|| 1\damagefactor=100 || Integer || Percentage of damage dealt ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   110
|| 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
   111
|| 1\health=100 || Integer || The initial health of the hogs ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   112
|| 1\suddendeath=15 || Integer || Turns before "Sudden Death" mode begins ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   113
|| 1\caseprobability=5 || Integer || Number of turns between cases drops ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   114
|| 1\minestime=3 || Integer || Seconds before mines explode ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   115
|| 1\minesnum=4 || Integer || Number of mines on a level ||
5341977e86a1 Created wiki page through web user interface.
jacoberen@gmail.com
parents:
diff changeset
   116
|| 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
   117
|| 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
   118
|| 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
   119
|| 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
   120
|| 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
   121
|| 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
   122
|| 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
   123
|| 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
   124
|| 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
   125
|| 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
   126
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   127
= `TeamName.hwt` =
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   128
_One file per team_
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   129
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   130
== {{{[Team]}}} ==
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   131
_General team settings_
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   132
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   133
|| *Setting* || *Type* || *Description* ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   134
|| Name=!TeamName || String || Name of team ||
163
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   135
|| 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
   136
|| 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
   137
|| Voicepack=Default || String || Sounds used for hog voice ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   138
|| 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
   139
|| 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
   140
|| 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
   141
|| Wins=0 || Integer || Number of rounds won with team _(Currently unused)_ ||
498
1a6fa9d619d3 Add worldedge and scriptparam
almikes@aol.com
parents: 168
diff changeset
   142
|| !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
   143
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   144
== {{{[Hedgehog0]}}} - {{{[Hedgehog7]}}} ==
575
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   145
_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
   146
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   147
|| *Setting* || *Type* || *Description* ||
4f3c17649b16 Edited wiki page ConfigurationFiles through web user interface.
jacoberen@gmail.com
parents: 162
diff changeset
   148
|| Name=Hedgehog Name || String || Name of hog ||
574
3f98b812ba63 Minor fixes (mainly clarifications and markup).
almikes@aol.com
parents: 498
diff changeset
   149
|| 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
   150
|| 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
   151
|| 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
   152
|| 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
   153
|| Suicides=0 || Integer || Suicides comitted by hog _(Currently unused)_ ||
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   154
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   155
== {{{[Binds]}}} ==
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   156
_Key bindings of the team._
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   157
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   158
_TO BE WRITTEN_
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   159
d6959c32b909 Updated team files (just stubs so far).
almikes@aol.com
parents: 574
diff changeset
   160
== {{{[Campaign%20<CAMPAIGN_NAME>]}}} ==
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   161
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
   162
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   163
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
   164
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   165
Campaign variable names and their values can are chosen by the Lua script authors, but there are some special variables which are used to determine which missions are available in the main menu:
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   166
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   167
|| *Setting* || *Type* || *Description* ||
582
96dd549eeead Typo fixes.
almikes@aol.com
parents: 581
diff changeset
   168
|| `Progress` || Integer || If present, this number of missions _additional to the first mission_ are unlocked in the menu, starting with the second mission and continuing with the following missions in their regular order (as specified in `campaign.ini`). If the number is `0`, only the first mission is available. ||
578
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   169
|| `UnlockedMissions` || Integer || An alternative way to store the unlocked missions in the main menu if the missions aren't unlocked in the regular order. This number specifies how many missions are unlocked. If this variable is set, then the variables `Mission1`, `Mission2`, etc. must be used to specfify the IDs of the unlocked missions. ||
b362aae4143f Info about special campaign variables
almikes@aol.com
parents: 575
diff changeset
   170
|| `Mission1` || Integer || The `campaign.ini` ID of the first unlocked mission, must be used together with `UnlockedMissions` ||
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   171
|| `Mission2` || Integer || ID of the second unlocked mission (continues with `Mission3`, `Mission4`, and so on) ||
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   172
581
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   173
If neither `Progress` nor `UnlockedMissions` are present, only the first mission is unlocked.
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   174
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   175
=== Examples ===
581
210498f64820 Corrected some factual mistakes about Progress campaign variable.
almikes@aol.com
parents: 580
diff changeset
   176
Simple campaign with 10 missions, missions 1-5 are available:
580
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   177
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   178
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   179
[Campaign%20Simple_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   180
Progress=4
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   181
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   182
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   183
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
   184
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   185
[Campaign%20Complex_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   186
UnlockedMissions=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   187
Mission1=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   188
Mission2=7
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   189
Mission3=3
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   190
}}}
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   191
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   192
Another campaign with some custom campaign variables:
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   193
{{{
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   194
[Campaign%20Another_Campaign]
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   195
Progress=2
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   196
MyCustomVariable=54
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   197
MyCustomString=Hedgewars
79ecca48492f Typo fix and examples
almikes@aol.com
parents: 578
diff changeset
   198
}}}