CommandLineOptions.wiki
changeset 291 a40772f88335
parent 290 b681434f3ef9
child 292 27c4a3aec2a0
equal deleted inserted replaced
290:b681434f3ef9 291:a40772f88335
    44   * {{{--low-quality}}} - Lowers the game quality
    44   * {{{--low-quality}}} - Lowers the game quality
    45   * {{{--stereo [type]}}} - Sets stereoscopic rendering type (1 to 14)
    45   * {{{--stereo [type]}}} - Sets stereoscopic rendering type (1 to 14)
    46   * {{{--help}}} - Shows this list of command line options
    46   * {{{--help}}} - Shows this list of command line options
    47 
    47 
    48 === More Advanced use ===
    48 === More Advanced use ===
    49 Generally you don't need such options but here they are for full documentation:
    49 Generally you don't need to set these options but here they are for full documentation:
    50 
    50 
    51   * {{{--frame-interval [interval]}}} - Sets minimum timer interval between each frame in milliseconds. Ex: 40 would make the game run at most 25 fps
    51   * {{{--frame-interval [interval]}}} - Sets minimum interval (in ms) between each frame. Eg, 40 would make the game run at most 25 fps
    52   * {{{--raw-quality [flags]}}} - (For advanced users only). Manually specifies the reduced quality flags, see below. 
    52   * {{{--raw-quality [flags]}}} - (For advanced users only). Manually specifies the reduced quality flags, see below. 
    53   * {{{--stats-only}}} - Outputs the round information without launching the game
    53   * {{{--stats-only}}} - Outputs the round information without launching the game, useful for statistics only
    54   * {{{--fullscreen-width [size]}}} - Starts the game with the given width (in pixels) when fullscreen
    54   * {{{--fullscreen-width [size]}}} - Starts the game with the given width (in pixels) when fullscreen
    55   * {{{--fullscreen-height [size]}}} - Starts the game with the given height (in pixels) when fullscreen
    55   * {{{--fullscreen-height [size]}}} - Starts the game with the given height (in pixels) when fullscreen
    56 
    56 
    57 Note: any modification to the command line arguments should be reflected in the autostart .desktop file, game.cpp, GameInterfaceBridge.m.
    57 Note: any modification to the command line arguments should be reflected in the autostart .desktop file, game.cpp, GameInterfaceBridge.m.
    58 
    58 
    59 --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.
    59 --prefix location is usually hardcoded at compile time, but should you changed the installation directory, then you can use this flag to override it; alternatively you can just specify --user-prefix.
    60 
    60 
    61 Personal game data is by default contained in the following directory:
    61 Personal game data is by default contained in the following directory:
    62 
    62 
    63   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
    63   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
    64   * _Linux_: {{{~/.hedgewars}}}
    64   * _Linux_: {{{~/.hedgewars}}}
    65   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
    65   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
    66 
    66 
    67 --raw-quality value is determined by combining the values of the flags you wish to enable.
    67 --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]
    68 Up to date variables (in hex) are online. [http://code.google.com/p/hedgewars/source/browse/hedgewars/uConsts.pas#62 uConsts.pas]
       
    69 
    68 
    70   * {{{qLowRes        = 1}}}
    69   * {{{qLowRes        = 1}}}
    71   * {{{rqBlurryLand   = 2}}}
    70   * {{{rqBlurryLand   = 2}}}
    72   * {{{rqNoBackground = 4}}}
    71   * {{{rqNoBackground = 4}}}
    73   * {{{rqSimpleRope   = 8}}}
    72   * {{{rqSimpleRope   = 8}}}
    80   * {{{rqTooltipsOff  = 1024}}}
    79   * {{{rqTooltipsOff  = 1024}}}
    81   * {{{rqDesyncVBlank = 2048}}}
    80   * {{{rqDesyncVBlank = 2048}}}
    82 
    81 
    83 Ex: to have blurry land and simple rope, you would use the number 10 (2+8)
    82 Ex: to have blurry land and simple rope, you would use the number 10 (2+8)
    84 
    83 
       
    84 There are some internal commands, such as --internal, --port [int], that are not meant for command line usage.
       
    85 
    85 If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
    86 If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
    86 [http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
    87 [http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
    87 
       
    88 == Some examples ==
       
    89 let's see some *GOOD* examples
       
    90 
       
    91 {{{
       
    92 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd
       
    93 $ hwengine pathtohedgewars/ installpath/hedgewars/Data anywhere/replay.hwd --width 1024 --height 768
       
    94 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --nosound
       
    95 }}}