Skip to content

Tweak command-line arguments to make them more UNIX-like

Rafał Mikrut requested to merge github/fork/Calinou/tweak-command-line-arguments into master

Created by: Calinou

Also improves the command-line help text readability.

Note: this pull request may break some things (such as automation scripts), since it does not leave aliases for compatibility.

The help text now looks like this:

Godot Engine v3.0.alpha.custom_build (c) 2008-2017 Juan Linietsky, Ariel Manzur.
Usage: godot.windows.opt.tools.64.exe [options] [path to scene or 'project.godot' file]
Options:
  -h, --help                       Display this help message.
  --path <directory>               Play the project (<directory> must contain a 'project.godot' file).
  -e, --editor                     Bring up the editor instead of running the scene.
  --test <test>                    Run a test ('string', 'containers', 'math', 'render', 'multimesh', 'gui', 'io', 'shaderlang', 'physics').
  -r, --resolution <W>x<H>         Request window resolution.
  -p, --position <X>,<Y>           Request window position.
  -f, --fullscreen                 Request fullscreen mode.
  -m, --maximized                  Request a maximized window.
  -w, --windowed                   Request windowed mode.
  --video-driver <driver>          Video driver ('GLES2').
  --low-dpi                        Force low-DPI mode (macOS only).
  --audio-driver <driver>          Audio driver ('RtAudio-DirectSound').
  --render-thread <mode>           Render thread mode ('unsafe', 'safe', 'separate').
  -s, --script <script>            Run a script.
  -d, --debug                      Debug (local stdout debugger).
  -r, --remote-debug <address>     Remote debug (<ip>:<port> host address).
  --frame-delay <ms>               Simulate high CPU load (delay each frame by <ms> milliseconds).
  --time-scale <scale>             Force time scale (higher values are faster, 1.0 is normal speed).
  -b, --breakpoints                Breakpoint list as source::line comma-separated pairs, no spaces (use %20, %2C, ... instead).
  -v, --verbose                    Use verbose stdout mode.
  -l, --language <locale>          Use a specific locale (<locale> being a two-letter code).
  --remote-fs <host/IP>[:<port>]   Remote filesystem.
  --remote-fs-password <password>  Password for remote filesystem.
  --doctool <file>                 Dump the whole engine API to <file> in XML format. If <file> exists, it will be merged.
  --no-docbase                     Disallow dumping the base types (used with --doctool).
  --export <target>                Export the project using the given export target.

Merge request reports