ConfigurationFiles: Add some settings stuff
authorWuzzy
Thu, 21 Apr 2016 20:46:22 +0100
changeset 873 5da391a0d8ac
parent 872 8aa46333bfe2
child 874 fbdbce68efd8
ConfigurationFiles: Add some settings stuff
ConfigurationFiles.wiki
--- a/ConfigurationFiles.wiki	Thu Apr 21 20:35:16 2016 +0100
+++ b/ConfigurationFiles.wiki	Thu Apr 21 20:46:22 2016 +0100
@@ -14,21 +14,25 @@
 _Graphics rendering settings, back-end (engine)_
 
 || *Setting* || *Type* || *Description* ||
-|| resolution=1280x768 || String || Screen resolution the game is rendered at ||
+|| fullscreenResolution=1280x768 || String || Screen resolution the game is rendered when using fullscreen mode ||
+|| windowedWidth=1280 || Integer || Window width when using window mode ||
+|| windowedHeight=1024 || Integer || Window height when using window mode ||
 || fullscreen=false || Boolean || If the game is rendered in fullscreen ||
-|| quality=5 || Integer || Quality of game rendering ||
+|| quality=5 || Integer || Quality of game rendering (0-5, 5 is best quality) ||
 || stereo=0 || Integer || Mode of stereoscopic 3D rendering, 0 being no 3D ||
 
 === {{{[frontend]}}} ===
 _Graphics and sound settings, front-end (GUI)_
 
 || *Setting* || *Type* || *Description* ||
+|| roomslist_header || ??? || ??? ||
+|| roomslist_splitter || ??? || ??? ||
 || effects=true || Boolean || If game effects are displayed ||
 || fullscreen=false || Boolean || If the game is in fullscreen-mode, instead of windowed-mode ||
 || width=800 || Integer || Width of the game window ||
 || height=600 || Integer || Height of the game window ||
-|| sound=true || Boolean || If sounds are being played ||
-|| music=true || Boolean || If background music is being played ||
+|| sound=true || Boolean || If sounds are being played in the frontend ||
+|| music=true || Boolean || If background music is being played in the frontend ||
 
 === {{{[misc]}}} ===
 _Miscellaneous settings_
@@ -40,20 +44,21 @@
 || 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 ||
 
 === {{{[audio]}}} ===
-_Sound rendering settings, back-end_
+_Sound settings for the sounds and music in the game itself_
 
 || *Setting* || *Type* || *Description* ||
-|| sound=true || Boolean || If sound effects should be rendered ||
-|| music=true || Boolean || If background music should be rendered ||
-|| volume=100 || Integer || Volume level of sound effects and music rendering ||
+|| sound=true || Boolean || If sound effects should be played  in-game ||
+|| music=true || Boolean || If background music should be played in-game ||
+|| volume=100 || Integer || Volume level (in percent) of sound effects and music ||
 
 === {{{[net]}}} ===
 _Online and LAN settings_
 
 || *Setting* || *Type* || *Description* ||
 || nick=username || String || Username/nickname used for online play, or promt the user when first connecting if left blank ||
-|| passwordhash=@!ByteArray(d41d8cd98f00b204e9800998ecf8427e) || Byte array || Hash of password used for online play ||
+|| passwordhash=d41d8cd98f00b204e9800998ecf8427e || String || Hash of password used for online play ||
 || passwordlength=0 || Integer || Lenght of unhashed password string ||
+|| savepassword=true || Boolean || If true, password will be saved ||
 || ip=10.0.0.0 || String || Default IP-address when connecting to a LAN server, stored in human-readable dot-notation ||
 || port=46631 || Integer || Default port number when connecting to a LAN server ||
 || servername=hedgewars server || String || Default name when creating a LAN server ||
@@ -66,6 +71,17 @@
 || show=false || Boolean || If the number of frames rendered per second should be shown in-game ||
 || limit=27 || Integer || Maximum number of frames rendered per second, calculated as _1000 / (35 - limit)_ ||
 
+=== {{{[proxy]}}} ===
+_Proxy settings_
+
+|| *Setting* || *Type* || *Description* ||
+|| 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. ||
+|| host || String || Hostname or IP adress of proxy ||
+|| port || Integer || Port number of proxy ||
+|| login || String || User name to login to the proxy ||
+|| password || String || Password (in clear text) to login to the proxy ||
+
+
 === {{{Binds}}} ===
 This section defines the global key bindings. They can be overwritten by teams.