--- a/CommandLineOptions.wiki Fri Jan 18 20:17:59 2013 +0000
+++ b/CommandLineOptions.wiki Tue Jan 29 23:07:40 2013 +0000
@@ -20,48 +20,43 @@
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 replay file> [options]}}}
+{{{$ hwengine [options] <path to replay file>}}}
-By default hwengine will look in the current folder for game assets, if you wish to use another directory you should set the --prefix option.
+By default hwengine will look in the current folder for game assets, if you wish to use another directory you should set the --prefix and --user-prefix option. See below for even more commands.
-The replay file can be stored anywhere.
+The replay file can be stored anywhere. Note that, as always, engine can only load replay files generated from the same Hedgewars version.
== Advanced Use ==
-It is possible to specify settings by adding additional arguments:
+It is possible to specify almost any settings by adding additional arguments:
- * {{{--prefix [path to hedgewars folder]}}} - Sets the path to game folder
- * {{{--user-prefix [path to hedgewars folder]}}} - Sets a secondary folder to find game content
- * {{{--locale [path to language file]}}} - Sets the game language
+ * {{{--prefix [path to Hedgewars data folder]}}} - Sets the path to the system game data folder
+ * {{{--user-prefix [path to custom Hedgewars folder]}}} - Sets the path to the custom data folder to find game content
+ * {{{--locale [language file]}}} - Sets the game language (en.txt for sample)
+ * {{{--nick [string]}}} - Represents the user nickname
* {{{--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
- * {{{--raw-quality [flags]}}} - (For advanced users only). Manually specifies the reduced quality flags, see below.
* {{{--nomusic}}} - Disables music
- * {{{--nosound}}} - Disables sound
- * {{{--fullscreen}}} - Starts in fullscreen
+ * {{{--nosound}}} - Disables sound effects
+ * {{{--fullscreen}}} - Starts game in fullscreen
* {{{--showfps}}} - Shows a fps counter in the top right
* {{{--altdmg}}} - Uses an alternative damage indicator
* {{{--low-quality}}} - Lowers the game quality
- * {{{--stats-only}}} - Outputs the round information without launching the game
+ * {{{--stereo [type]}}} - Sets stereoscopic rendering type (1 to 14)
* {{{--help}}} - Shows this list of command line options
-Note: any modification to the command line arguments should be reflected in the autostart .desktop file.
-
-== Deprecated Options ==
-
-These options are outdated and may be removed in the future, please use the above options:
+=== More Advanced use ===
+Generally you don't need such options but here they are for full documentation:
- * {{{--depth [color depth]}}}
- * {{{--set-video [screen width] [screen height] [color dept]}}}
- * {{{--set-audio [volume] [enable music] [enable sounds]}}}
- * {{{--set-other [language file] [full screen] [show FPS]}}}
- * {{{--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]}}}
+ * {{{--frame-interval [interval]}}} - Sets minimum timer interval between each frame in milliseconds. Ex: 40 would make the game run at most 25 fps
+ * {{{--raw-quality [flags]}}} - (For advanced users only). Manually specifies the reduced quality flags, see below.
+ * {{{--stats-only}}} - Outputs the round information without launching the game
+ * {{{--fullscreen-width [size]}}} - Starts the game with the given width (in pixels) when fullscreen
+ * {{{--fullscreen-height [size]}}} - Starts the game with the given height (in pixels) when fullscreen
-== Advanced Option Explanations ==
+Note: any modification to the command line arguments should be reflected in the autostart .desktop file, game.cpp, GameInterfaceBridge.m.
---prefix and --user-prefix should refer to an installation folder where the game content can be found (DATA_INSTALL_DIR cmake flag).
+--prefix location is usually hardcoded at compile time, but should you changed the installation directory you can use this flag to override it; alternatively you can just specify --user-prefix.
Personal game data is by default contained in the following directory:
@@ -97,12 +92,4 @@
$ hwengine installpath/hedgewars/Data anywhere/replay.hwd
$ hwengine pathtohedgewars/ installpath/hedgewars/Data anywhere/replay.hwd --width 1024 --height 768
$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound
-}}}
-
-and some *BAD* examples
-
-{{{
-$ hwengine anywhere/replay.hwd
-$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 1024 768
-$ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound 1
}}}
\ No newline at end of file