CommandLineOptions.wiki
changeset 3 ba86e3ce90c3
child 4 99b86a2d46d2
equal deleted inserted replaced
2:ba21be2f1b7a 3:ba86e3ce90c3
       
     1 #summary One-sentence summary of this page.
       
     2 #labels Documentation,Engine,Frontend
       
     3 
       
     4 = Frontend =
       
     5 
       
     6 _are there any command line options?_
       
     7 
       
     8 
       
     9 = Engine =
       
    10 
       
    11 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:
       
    12 
       
    13   * _Windows_: {{{%USERPROFILE%\Hedgewars}}}
       
    14   * _Linux_: {{{~/.hedgewars}}}
       
    15   * _Mac OS X_: {{{~/Library/Application Support/Hedgewars}}}
       
    16 
       
    17 
       
    18 == Standard Use ==
       
    19 {{{$ hwengine [path to data folder] [path to replay file]}}}
       
    20 
       
    21 the data folder is where you installed the game, or where you configured it when you compiled.
       
    22 
       
    23 == Advanced Use ==
       
    24 it is possible to specify additional settings by adding one third argument (and only one)
       
    25 
       
    26   * {{{--set-video [screen width] [screen height] [color dept]}}}
       
    27   * {{{--set-audio [volume] [enable music] [enable sounds]}}}
       
    28   * {{{--set-other [language file] [full screen] [show FPS]}}}
       
    29 
       
    30 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).
       
    31 
       
    32 == Very Advanced Use (l33t only) ==
       
    33 (intentional non-explanation of the commands below, like any other l33t documentation; plus they're really self explanatory)
       
    34 
       
    35   * {{{--set-multimedia [screen height] [screen width] [color dept] [volume] [enable music] [enable sounds] [language file] [full screen]}}}
       
    36   * {{{--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]}}}
       
    37 
       
    38 == Some examples ==
       
    39 let's see some *GOOD* examples
       
    40 
       
    41 {{{$ hwengine installpath/hedgewars/Data anywhere/replay.hwd
       
    42 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 800 600 32
       
    43 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-everything 1280 1024 32 128 1 1 en.txt 0 0 0 8 0}}}
       
    44 
       
    45 and some *BAD* examples
       
    46 
       
    47 {{{$ hwengine anywhere/replay.hwd
       
    48 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 800 600
       
    49 $ hwengine installpath/hedgewars/Data anywhere/replay.hwd --set-video 800 600 32 --set-audio 128 1 1}}}