Edited wiki page CommandLineOptions through web user interface.
--- a/CommandLineOptions.wiki Thu Dec 06 09:43:58 2012 +0000
+++ b/CommandLineOptions.wiki Sat Dec 15 18:36:30 2012 +0000
@@ -17,40 +17,80 @@
= Engine =
-It is possible to start a replay or save file directly from the terminal issuing the standalone {{{hwengine}}} utility with very simple syntax. The replay files are usually contained in the configuration directory:
+It is possible to start a replay or save file directly from the terminal issuing the standalone {{{hwengine}}} utility with very simple syntax.
+
+== Standard Use ==
+{{{$ hwengine [path to hedgewars folder] <path to data folder> <path to replay file>}}}
+
+The hedgewars folder is optional, but may be useful if you have more than one installation.
+
+The data folder is where you installed the game, or where you configured it at compile time.
+By default it is contained in the following directory:
* _Windows_: {{{%USERPROFILE%\Hedgewars}}}
* _Linux_: {{{~/.hedgewars}}}
* _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
-
-== Standard Use ==
-{{{$ hwengine [path to data folder] [path to replay file]}}}
-
-the data folder is where you installed the game, or where you configured it when you compiled.
+The replay file can be stored anywhere.
== Advanced Use ==
-it is possible to specify additional settings by adding one third argument (and only one)
+It is possible to specify settings by adding additional arguments:
+ * {{{--locale [path to language file]}}} - Sets the game language
+ * {{{--width [size]}}} - Starts the game with the given width (in pixels)
+ * {{{--height [size]}}} - Starts the game with the given height (in pixels)
+ * {{{--volume [level]}}} - Sets the volume level, possible values range from 0-100 (negative is muted)
+ * {{{--frame-interval [interval]}}} - Sets minimum timer interval between each frame in milliseconds. Ex: 40 would make the game run at most 25 fps
+ * {{{--nomusic}}} - Disables music
+ * {{{--nosound}}} - Disables sound
+ * {{{--fullscreen}}} - Starts in fullscreen
+ * {{{--showfps}}} - Shows a fps counter in the top right
+ * {{{--altdmg}}} - Uses an alternative damage indicator
+ * {{{--low-quality}}} - Lowers the game quality
+ * {{{--raw-quality}}} - (For advanced users only). Manually specifies the reduced quality flags, see below.
+ * {{{--stats-only}}} - Outputs the round information without launching the game
+ * {{{--help}}} - Shows this list of command line options
+
+== Deprecated Options ==
+
+These options are outdated and may be removed in the future, please use the above options:
+
+ * {{{--depth [bits]}}}
* {{{--set-video [screen width] [screen height] [color dept]}}}
* {{{--set-audio [volume] [enable music] [enable sounds]}}}
* {{{--set-other [language file] [full screen] [show FPS]}}}
-
-these options always require three additional configurations and are mutually exclusive (that is, you can only set one of them, if you need to configure more, you have to use the l33t arguments below).
+ * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
+ * {{{--set-everything [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen] [show FPS] [alternate damage] [timer value] [reduced quality]}}}
== Very Advanced Use (l33t only) ==
-(intentional non-explanation of the commands below, like any other l33t documentation; plus they're really self explanatory)
+If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
+[http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
+
+--raw-quality value is determined by combining the values of the flags you wish to enable.
+Up to date variables (in hex) are online. [http://code.google.com/p/hedgewars/source/browse/hedgewars/uConsts.pas#62 uConsts.pas]
- * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
- * {{{--set-everything [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen] [show FPS] [alternate damage] [timer value] [reduced quality]}}}
+ * {{{qLowRes = 1}}}
+ * {{{rqBlurryLand = 2}}}
+ * {{{rqNoBackground = 4}}}
+ * {{{rqSimpleRope = 8}}}
+ * {{{rq2DWater = 16}}}
+ * {{{rqAntiBoom = 32}}}
+ * {{{rqKillFlakes = 64}}}
+ * {{{rqSlowMenu = 128}}}
+ * {{{rqPlainSplash = 256}}}
+ * {{{rqClampLess = 512}}}
+ * {{{rqTooltipsOff = 1024}}}
+ * {{{rqDesyncVBlank = 2048}}}
+
+Ex: to have blurry land and simple rope, you would use the number 10 (2+8)
== Some examples ==
let's see some *GOOD* examples
{{{
$ hwengine installpath/hedgewars/Data anywhere/replay.hwd
-$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 1920 1080 32
-$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-everything 1280 1024 32 128 1 1 en.txt 0 0 0 8 0
+$ hwengine pathtohedgewars/ installpath/hedgewars/Data anywhere/replay.hwd --width 1024 ---height 768
+$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound
}}}
and some *BAD* examples
@@ -58,5 +98,5 @@
{{{
$ hwengine anywhere/replay.hwd
$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 1024 768
-$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 800 600 32 --set-audio 128 1 1
+$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound 1
}}}
\ No newline at end of file