CommandLineOptions.wiki
changeset 273 e165ada6aae2
parent 6 1744484ba5c0
child 274 aae06d0bd175
equal deleted inserted replaced
272:491cd6cb653c 273:e165ada6aae2
    15 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
    15 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
    16 }}}
    16 }}}
    17 
    17 
    18 = Engine =
    18 = Engine =
    19 
    19 
    20 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:
    20 It is possible to start a replay or save file directly from the terminal issuing the standalone {{{hwengine}}} utility with very simple syntax. 
       
    21 
       
    22 == Standard Use ==
       
    23 {{{$ hwengine [path to hedgewars folder] <path to data folder> <path to replay file>}}}
       
    24 
       
    25 The hedgewars folder is optional, but may be useful if you have more than one installation.
       
    26 
       
    27 The data folder is where you installed the game, or where you configured it at compile time.
       
    28 By default it is contained in the following directory:
    21 
    29 
    22   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
    30   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
    23   * _Linux_: {{{~/.hedgewars}}}
    31   * _Linux_: {{{~/.hedgewars}}}
    24   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
    32   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
    25 
    33 
    26 
    34 The replay file can be stored anywhere.
    27 == Standard Use ==
       
    28 {{{$ hwengine [path to data folder] [path to replay file]}}}
       
    29 
       
    30 the data folder is where you installed the game, or where you configured it when you compiled.
       
    31 
    35 
    32 == Advanced Use ==
    36 == Advanced Use ==
    33 it is possible to specify additional settings by adding one third argument (and only one)
    37 It is possible to specify settings by adding additional arguments:
    34 
    38 
       
    39   * {{{--locale [path to language file]}}} - Sets the game language
       
    40   * {{{--width [size]}}} - Starts the game with the given width (in pixels)
       
    41   * {{{--height [size]}}} - Starts the game with the given height (in pixels)
       
    42   * {{{--volume [level]}}} - Sets the volume level, possible values range from 0-100 (negative is muted)
       
    43   * {{{--frame-interval [interval]}}} - Sets minimum timer interval between each frame in milliseconds. Ex: 40 would make the game run at most 25 fps
       
    44   * {{{--nomusic}}} - Disables music
       
    45   * {{{--nosound}}} - Disables sound
       
    46   * {{{--fullscreen}}} - Starts in fullscreen
       
    47   * {{{--showfps}}} - Shows a fps counter in the top right
       
    48   * {{{--altdmg}}} - Uses an alternative damage indicator
       
    49   * {{{--low-quality}}} - Lowers the game quality
       
    50   * {{{--raw-quality}}} - (For advanced users only). Manually specifies the reduced quality flags, see below. 
       
    51   * {{{--stats-only}}} - Outputs the round information without launching the game
       
    52   * {{{--help}}} - Shows this list of command line options
       
    53 
       
    54 == Deprecated Options ==
       
    55 
       
    56 These options are outdated and may be removed in the future, please use the above options:
       
    57 
       
    58   * {{{--depth [bits]}}}
    35   * {{{--set-video [screen width] [screen height] [color dept]}}}
    59   * {{{--set-video [screen width] [screen height] [color dept]}}}
    36   * {{{--set-audio [volume] [enable music] [enable sounds]}}}
    60   * {{{--set-audio [volume] [enable music] [enable sounds]}}}
    37   * {{{--set-other [language file] [full screen] [show FPS]}}}
    61   * {{{--set-other [language file] [full screen] [show FPS]}}}
    38 
    62   * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
    39 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).
    63   * {{{--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]}}}
    40 
    64 
    41 == Very Advanced Use (l33t only) ==
    65 == Very Advanced Use (l33t only) ==
    42 (intentional non-explanation of the commands below, like any other l33t documentation; plus they're really self explanatory)
    66 If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
       
    67 [http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
    43 
    68 
    44   * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
    69 --raw-quality value is determined by combining the values of the flags you wish to enable.
    45   * {{{--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]}}}
    70 Up to date variables (in hex) are online. [http://code.google.com/p/hedgewars/source/browse/hedgewars/uConsts.pas#62 uConsts.pas]
       
    71 
       
    72   * {{{qLowRes        = 1}}}
       
    73   * {{{rqBlurryLand   = 2}}}
       
    74   * {{{rqNoBackground = 4}}}
       
    75   * {{{rqSimpleRope   = 8}}}
       
    76   * {{{rq2DWater      = 16}}}
       
    77   * {{{rqAntiBoom     = 32}}}
       
    78   * {{{rqKillFlakes   = 64}}}
       
    79   * {{{rqSlowMenu     = 128}}}
       
    80   * {{{rqPlainSplash  = 256}}}
       
    81   * {{{rqClampLess    = 512}}}
       
    82   * {{{rqTooltipsOff  = 1024}}}
       
    83   * {{{rqDesyncVBlank = 2048}}}
       
    84 
       
    85 Ex: to have blurry land and simple rope, you would use the number 10 (2+8)
    46 
    86 
    47 == Some examples ==
    87 == Some examples ==
    48 let's see some *GOOD* examples
    88 let's see some *GOOD* examples
    49 
    89 
    50 {{{
    90 {{{
    51 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd
    91 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd
    52 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 1920 1080 32
    92 $ hwengine pathtohedgewars/ installpath/hedgewars/Data anywhere/replay.hwd --width 1024 ---height 768
    53 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-everything 1280 1024 32 128 1 1 en.txt 0 0 0 8 0
    93 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound
    54 }}}
    94 }}}
    55 
    95 
    56 and some *BAD* examples
    96 and some *BAD* examples
    57 
    97 
    58 {{{
    98 {{{
    59 $ hwengine anywhere/replay.hwd
    99 $ hwengine anywhere/replay.hwd
    60 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 1024 768
   100 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 1024 768
    61 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 800 600 32 --set-audio 128 1 1
   101 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound 1
    62 }}}
   102 }}}