Edited wiki page CommandLineOptions through web user interface.
authorSmasher816@gmail.com
Mon, 17 Dec 2012 00:08:32 +0000
changeset 276 5d525c4b0130
parent 275 910cde9995b8
child 277 718cb9d18147
Edited wiki page CommandLineOptions through web user interface.
CommandLineOptions.wiki
--- a/CommandLineOptions.wiki	Sat Dec 15 23:18:47 2012 +0000
+++ b/CommandLineOptions.wiki	Mon Dec 17 00:08:32 2012 +0000
@@ -20,21 +20,17 @@
 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>}}}
+{{{$ hwengine <path to replay file> [options]}}}
 
-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}}}
+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.
 
 The replay file can be stored anywhere.
 
 == Advanced Use ==
 It is possible to specify settings by adding additional arguments:
 
-  * {{{--user-dir [path to hedgewars folder]}}} - Sets the path to game folder
+  * {{{--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
   * {{{--width [size]}}} - Starts the game with the given width (in pixels)
   * {{{--height [size]}}} - Starts the game with the given height (in pixels)
@@ -63,7 +59,15 @@
   * {{{--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]}}}
 
-== Advanced Quality Options ==
+== Advanced Option Explanations ==
+
+--prefix and --user-prefix should refer to an installation folder where the game content can be found (DATA_INSTALL_DIR cmake flag).
+
+Personal game data is by default it is contained in the following directory:
+
+  * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
+  * _Linux_: {{{~/.hedgewars}}}
+  * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
 
 --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]