|
1 #summary Documentation of configuration files on desktop |
|
2 #labels Documentation |
|
3 |
|
4 = Introduction = |
|
5 |
|
6 This documents the structure and content of the configuration (.ini) files found in the desktop version of Hedgewars. |
|
7 |
|
8 = Hedgewars.ini: = |
|
9 |
|
10 == {{{[video]}}} == |
|
11 _Graphics rendering settings, back-end (engine)_ |
|
12 |
|
13 || *Setting* || *Type* || *Description* || |
|
14 || resolution=1280x768 || String || Screen resolution the game is rendered at || |
|
15 || fullscreen=false || Bolean || If the game is rendered in fullscreen || |
|
16 || quality=5 || Integer || Quality of game rendering || |
|
17 || stereo=0 || Integer || Mode of stereoscopic 3D rendering, 0 being no 3D || |
|
18 |
|
19 == {{{[frontend]}}} == |
|
20 _Graphics and sound settings, front-end (GUI)_ |
|
21 |
|
22 || *Setting* || *Type* || *Description* || |
|
23 || effects=true || Bolean || If game effects are displayed || |
|
24 || fullscreen=false || Bolean || If the game is in fullscreen-mode, instead of windowed-mode || |
|
25 || width=800 || Integer || Width of the game window || |
|
26 || height=600 || Integer || Height of the game window || |
|
27 || sound=true || Bolean || If sounds are being played || |
|
28 || music=true || Bolean || If background music is being played || |
|
29 |
|
30 == {{{[misc]}}} == |
|
31 _Miscellaneous settings_ |
|
32 |
|
33 || *Setting* || *Type* || *Description* || |
|
34 || weaponTooltips=true || Bolean || If tooltips should be shown in the ammo menu || |
|
35 || altdamage=false || Bolean || If damage pop-ups should be shown on every shot, instead of only at the end of a round || |
|
36 || appendTimeToRecords=false || Bolean || If date and time should be appended to the file name when demo records are saved || |
|
37 || 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 || |
|
38 |
|
39 == {{{[audio]}}} == |
|
40 _Sound rendering settings, back-end_ |
|
41 |
|
42 || *Setting* || *Type* || *Description* || |
|
43 || sound=true || Bolean || If sound effects should be rendered || |
|
44 || music=true || Bolean || If background music should be rendered || |
|
45 || volume=100 || Integer || Volume level of sound effects and music rendering || |
|
46 |
|
47 == {{{[net]}}} == |
|
48 _Online and LAN settings_ |
|
49 |
|
50 || *Setting* || *Type* || *Description* || |
|
51 || nick=username || String || Username/nickname used for online play, or promt the user when first connecting if left blank || |
|
52 || passwordhash=@ByteArray(d41d8cd98f00b204e9800998ecf8427e) || Byte array || Hash of password used for online play || |
|
53 || passwordlength=0 || Integer || Lenght of unhashed password string || |
|
54 || ip=10.0.0.0 || String || Default IP-address when connecting to a LAN server, stored in human-readable dot-notation || |
|
55 || port=46631 || Integer || Default port number when connecting to a LAN server || |
|
56 || servername=hedgewars server || String || Default name when creating a LAN server || |
|
57 || serverport=46631 || Integer || Default port number when creating a LAN server || |
|
58 |
|
59 == {{{[fps]}}} == |
|
60 _Frames per second settings_ |
|
61 |
|
62 || *Setting* || *Type* || *Description* || |
|
63 || show=false || Bolean || If the number of frames rendered per second should be shown in-game || |
|
64 || limit=27 || Integer || Maximum number of frames rendered per second, mapped to an enumerated list of possible values || |
|
65 |
|
66 = Weapons.ini: = |
|
67 |
|
68 == {{{[General]}}} == |
|
69 _List of weapon settings as key-value pairs, each with a string name and integer value_ |
|
70 |
|
71 || *Setting* || *Type* || *Description* || |
|
72 || Default=93919...11101 || Integer || Which weapons are allowed in the default mode || |
|
73 |
|
74 = Schemes.ini: = |
|
75 |
|
76 == {{{[schemes]}}} == |
|
77 _List of custom scheme settings as key-value pairs, each with a key of "index number of scheme backslash setting name"_ |
|
78 |
|
79 || *Setting* || *Type* || *Description* || |
|
80 || size=1 || Integer || Number of custom scheme settings || |
|
81 || 1\name=new || String || Name of scheme || |
|
82 || 1\fortsmode=false || Bolean || If forts are enabled || |
|
83 || 1\divteams=false || Bolean || If teams start at the opposite side of the terrain || |
|
84 || 1\solidland=false || Bolean || If land is indestructible || |
|
85 || 1\border=false || Bolean || If an insestructible border is added around the map || |
|
86 || 1\lowgrav=false || Bolean || If gravity is lowered || |
|
87 || 1\laser=false || Bolean || If aiming is assisted with laser sights || |
|
88 || 1\invulnerability=false || Bolean || If hogs have a personal forcefield || |
|
89 || 1\resethealth=false || Bolean || If living hogs' health is reset to 100 at end of round || |
|
90 || 1\vampiric=false || Bolean || If hogs gain life equal to 80 percent of the damage they deal || |
|
91 || 1\karma=false || Bolean || If hogs lose life equal to the damage they deal || |
|
92 || 1\artillery=false || Bolean || If hogs are unable to move || |
|
93 || 1\randomorder=true || Bolean || If turn order is generated randomly || |
|
94 || 1\king=false || Bolean || If a chess-like king is used || |
|
95 || 1\placehog=false || Bolean || If players take turns placing their hogs before the start of a game || |
|
96 || 1\sharedammo=false || Bolean || If ammo is shared between all teams of the same color || |
|
97 || 1\disablegirders=false || Bolean || If girders are removed from randomly-generated maps || |
|
98 || 1\disablelandobjects=false || Bolean || If land objects are removed from randomly-generated maps || |
|
99 || 1\aisurvival=false || Bolean || If AI hogs respawn on death || |
|
100 || 1\infattack=false || Bolean || If hogs can attack an unlimited number of times each turn || |
|
101 || 1\resetweps=false || Bolean || If weapons are reset at end of each turn || |
|
102 || 1\perhogammo=false || Bolean || If each hog has seperate ammo || |
|
103 || 1\disablewind=false || Bolean || If wind is disabled || |
|
104 || 1\morewind=false || Bolean || If wind is much stronger then usually || |
|
105 || 1\tagteam=false || Bolean || If players in a team share time on each turn || |
|
106 || 1\bottomborder=false || Bolean || If an indestructible border is added at the bottom of the map || |
|
107 || 1\damagefactor=100 || Integer || Percentage of damage dealt || |
|
108 || 1\turntime=45 || Integer || Maximum time in seconds of each turn || |
|
109 || 1\health=100 || Integer || The initial health of the hogs || |
|
110 || 1\suddendeath=15 || Integer || Turns before "Sudden Death" mode begins || |
|
111 || 1\caseprobability=5 || Integer || Number of turns between cases drops || |
|
112 || 1\minestime=3 || Integer || Seconds before mines explode || |
|
113 || 1\minesnum=4 || Integer || Number of mines on a level || |
|
114 || 1\minedudpct=0 || Integer || Percentage chance of each mine being a dud || |
|
115 || 1\explosives=2 || Integer || Number of explosives on a level || |
|
116 || 1\healthprobability=35 || Integer || Percentage chance of each create being a health crate || |
|
117 || 1\healthcaseamount=25 || Integer || Amount of life restored by each health crate || |
|
118 || 1\waterrise=47 || Integer || Number of pixels the water rises each turn in "Sudden Death" mode || |
|
119 || 1\healthdecrease=5 || Integer || Damage dealth each turn to hogs in water during "Sudden Death" mode || |
|
120 || 1\ropepct=100 || Integer || Maximum length of robe as a percentage || |
|
121 || 1\getawaytime=100 || Integer || Time you have to get away from an explosive after arming it, as a percentage || |