CommandLineOptions.wiki
changeset 293 2dc603c7d7e6
parent 292 27c4a3aec2a0
child 587 8105e95297e3
equal deleted inserted replaced
292:27c4a3aec2a0 293:2dc603c7d7e6
     1 #summary Full list of command line switches for hedgewars and hwengine
     1 #summary Full list of command line switches for hedgewars, hwengine and server
     2 #labels Documentation,Engine,Frontend
     2 #labels Documentation,Engine,Frontend
     3 
     3 
     4 The basic parameters to pass to the Hedgewars frontend and engine control the location of the game data, configuration files and saves.
     4 *Table of Contents*
       
     5 <wiki:toc max_depth="2" />
     5 
     6 
     6 = Frontend =
     7 ----
     7 
       
     8 There are two options that enable to load the data directory and the configuration directory in non standard locations.
       
     9 
       
    10   * {{{--data-dir=[path containing 'hedgewars/Data']}}}
       
    11   * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}
       
    12 
       
    13 You can set up both on the command line. The program exits if either of the folders is not correct; quotes are optional, but needed if your path contains spaces
       
    14 
       
    15 _Example_ 
       
    16 {{{
       
    17 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
       
    18 }}}
       
    19 
     8 
    20 = Engine =
     9 = Engine =
    21 
    10 
    22 It is possible to start a replay or save file directly from the terminal issuing the standalone {{{hwengine}}} utility with very simple syntax. 
    11 It is possible to start a replay or save file directly from the terminal issuing the standalone {{{hwengine}}} utility with very simple syntax. 
    23 
    12 
    79   * {{{rqPlainSplash  = 256}}}
    68   * {{{rqPlainSplash  = 256}}}
    80   * {{{rqClampLess    = 512}}}
    69   * {{{rqClampLess    = 512}}}
    81   * {{{rqTooltipsOff  = 1024}}}
    70   * {{{rqTooltipsOff  = 1024}}}
    82   * {{{rqDesyncVBlank = 2048}}}
    71   * {{{rqDesyncVBlank = 2048}}}
    83 
    72 
    84 Ex: to have blurry land and simple rope, you would use the number 10 (2+8)
    73 Eg: to have blurry land and simple rope, you would use the number 10 (2+8)
    85 
    74 
    86 There are some internal commands, such as --internal, --port [int], that are not meant for command line usage.
    75 There are some internal commands, such as --internal, --port [int], that are not meant for command line usage.
    87 
    76 
    88 If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
    77 If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
    89 [http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
    78 [http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
       
    79 
       
    80 ----
       
    81 
       
    82 = Frontend =
       
    83 
       
    84 There are two options that enable to load the data directory and the configuration directory in non standard locations.
       
    85 
       
    86   * {{{--data-dir=[path containing 'hedgewars/Data']}}}
       
    87   * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}
       
    88 
       
    89 You can set up both on the command line. The program exits if either one of the folders is not correct; quotes are optional, but needed if your path contains spaces.
       
    90 
       
    91 _Example_ 
       
    92 {{{
       
    93 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
       
    94 }}}
       
    95 
       
    96 
       
    97 ----
       
    98 
       
    99 = Server =
       
   100 
       
   101 Server can be configured to run on non standard port or to run as separate process.
       
   102 
       
   103   * {{{--port=PORT}}} - Server listens on PORT (-p)
       
   104   * {{{--dedicated=BOOL}}} - Spawn a separate process (-d)