diff --git a/03_usage/18_editor/01_command_line_tutorial.md b/03_usage/18_editor/01_command_line_tutorial.md index 7128b60..95ff5ef 100644 --- a/03_usage/18_editor/01_command_line_tutorial.md +++ b/03_usage/18_editor/01_command_line_tutorial.md @@ -1,7 +1,5 @@ - -Command line tutorial -===================== +# Command line tutorial Some developers like using the command line extensively. Pandemonium is @@ -12,7 +10,6 @@ suitable for this workflow. Note: - On Windows and Linux, you can run a Pandemonium binary in a terminal by specifying its relative or absolute path. @@ -24,147 +21,105 @@ Note: bundle from `Pandemonium` to another name, make sure to edit this command line accordingly. -Command line reference ----------------------- +## Command line reference **General options** -+----------------------------+----------------------------------------------------------------------+ + | Command | Description | -+----------------------------+----------------------------------------------------------------------+ -| `-h`, `--help`, `/?` | Display the list of command line options. | -+----------------------------+----------------------------------------------------------------------+ -| `--version` | Display the version string. | -+----------------------------+----------------------------------------------------------------------+ -| `-v`, `--verbose` | Use verbose stdout mode. | -+----------------------------+----------------------------------------------------------------------+ -| `--quiet` | Quiet mode, silences stdout messages. Errors are still displayed. | -+----------------------------+----------------------------------------------------------------------+ +|----------------------------|----------------------------------------------------------------------| +| `-h`, `--help`, `/?` | Display the list of command line options. | +| `--version` | Display the version string. | +| `-v`, `--verbose` | Use verbose stdout mode. | +| `--quiet` | Quiet mode, silences stdout messages. Errors are still displayed. | + **Run options** -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Command | Description | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `-e`, `--editor` | Start the editor instead of running the scene (`tools ( doc_introduction_to_the_buildsystem_tools )` must be enabled). | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `-p`, `--project-manager` | Start the project manager, even if a project is auto-detected (`tools ( doc_introduction_to_the_buildsystem_tools )` must be enabled). | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `-q`, `--quit` | Quit after the first iteration. | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `-l being a two-letter code). See `doc_locales` for more details. | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `--path must contain a 'project.pandemonium' file). | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `-u`, `--upwards` | Scan folders upwards for 'project.pandemonium' file. | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `--main-pack [:]` address). | -+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `--audio-driver x,x<H>` | Request window resolution. | +| `--position <X>,<Y>` | Request window position. | +| `--low-dpi` | Force low-DPI mode (macOS and Windows only). | +| `--no-window` | Run with invisible window. Useful together with `--script`. | + **Debug options** Note: - Debug options are only available in the editor and debug export templates (they require `debug` or `release_debug` build targets, see `doc_introduction_to_the_buildsystem_target` for more details). -+------------------------------+---------------------------------------------------------------------------------------------+ -| Command | Description | -+------------------------------+---------------------------------------------------------------------------------------------+ -| `-d`, `--debug` | Debug (local stdout debugger). | -+------------------------------+---------------------------------------------------------------------------------------------+ -| `-b`, `--breakpoints` | Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead). | -+------------------------------+---------------------------------------------------------------------------------------------+ -| `--profiling` | Enable profiling in the script debugger. | -+------------------------------+---------------------------------------------------------------------------------------------+ -| `--remote-debug
: milliseconds). | -+------------------------------+---------------------------------------------------------------------------------------------+ -| `--time-scale :<port>` address). | +| `--debug-collisions` | Show collision shapes when running the scene. | +| `--debug-navigation` | Show navigation polygons when running the scene. | +| `--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). | +| `--disable-render-loop` | Disable render loop so rendering only occurs when called explicitly from script. | +| `--disable-crash-handler` | Disable crash handler when supported by the platform code. | +| `--fixed-fps <fps>` | Force a fixed number of frames per second. This setting disables real-time synchronization. | +| `--print-fps` | Print the frames per second to the stdout. | + **Standalone tools** -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Command | Description | -+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `-s