CommandLineOptions.wiki
changeset 276 5d525c4b0130
parent 275 910cde9995b8
child 277 718cb9d18147
equal deleted inserted replaced
275:910cde9995b8 276:5d525c4b0130
    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. 
    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 
    21 
    22 == Standard Use ==
    22 == Standard Use ==
    23 {{{$ hwengine [path to hedgewars folder] <path to data folder> <path to replay file>}}}
    23 {{{$ hwengine <path to replay file> [options]}}}
    24 
    24 
    25 The data folder is where you installed the game, or where you configured it at compile time.
    25 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.
    26 By default it is contained in the following directory:
       
    27 
       
    28   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
       
    29   * _Linux_: {{{~/.hedgewars}}}
       
    30   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
       
    31 
    26 
    32 The replay file can be stored anywhere.
    27 The replay file can be stored anywhere.
    33 
    28 
    34 == Advanced Use ==
    29 == Advanced Use ==
    35 It is possible to specify settings by adding additional arguments:
    30 It is possible to specify settings by adding additional arguments:
    36 
    31 
    37   * {{{--user-dir [path to hedgewars folder]}}} - Sets the path to game folder
    32   * {{{--prefix [path to hedgewars folder]}}} - Sets the path to game folder
       
    33   * {{{--user-prefix [path to hedgewars folder]}}} - Sets a secondary folder to find game content
    38   * {{{--locale [path to language file]}}} - Sets the game language
    34   * {{{--locale [path to language file]}}} - Sets the game language
    39   * {{{--width [size]}}} - Starts the game with the given width (in pixels)
    35   * {{{--width [size]}}} - Starts the game with the given width (in pixels)
    40   * {{{--height [size]}}} - Starts the game with the given height (in pixels)
    36   * {{{--height [size]}}} - Starts the game with the given height (in pixels)
    41   * {{{--volume [level]}}} - Sets the volume level, possible values range from 0-100 (negative is muted)
    37   * {{{--volume [level]}}} - Sets the volume level, possible values range from 0-100 (negative is muted)
    42   * {{{--frame-interval [interval]}}} - Sets minimum timer interval between each frame in milliseconds. Ex: 40 would make the game run at most 25 fps
    38   * {{{--frame-interval [interval]}}} - Sets minimum timer interval between each frame in milliseconds. Ex: 40 would make the game run at most 25 fps
    61   * {{{--set-audio [volume] [enable music] [enable sounds]}}}
    57   * {{{--set-audio [volume] [enable music] [enable sounds]}}}
    62   * {{{--set-other [language file] [full screen] [show FPS]}}}
    58   * {{{--set-other [language file] [full screen] [show FPS]}}}
    63   * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
    59   * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
    64   * {{{--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]}}}
    60   * {{{--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]}}}
    65 
    61 
    66 == Advanced Quality Options ==
    62 == Advanced Option Explanations ==
       
    63 
       
    64 --prefix and --user-prefix should refer to an installation folder where the game content can be found (DATA_INSTALL_DIR cmake flag).
       
    65 
       
    66 Personal game data is by default it is contained in the following directory:
       
    67 
       
    68   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
       
    69   * _Linux_: {{{~/.hedgewars}}}
       
    70   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
    67 
    71 
    68 --raw-quality value is determined by combining the values of the flags you wish to enable.
    72 --raw-quality value is determined by combining the values of the flags you wish to enable.
    69 Up to date variables (in hex) are online. [http://code.google.com/p/hedgewars/source/browse/hedgewars/uConsts.pas#62 uConsts.pas]
    73 Up to date variables (in hex) are online. [http://code.google.com/p/hedgewars/source/browse/hedgewars/uConsts.pas#62 uConsts.pas]
    70 
    74 
    71   * {{{qLowRes        = 1}}}
    75   * {{{qLowRes        = 1}}}