diff --git a/tutorials/editor/command_line_tutorial.rst b/tutorials/editor/command_line_tutorial.rst index b058773b850..d9799703575 100644 --- a/tutorials/editor/command_line_tutorial.rst +++ b/tutorials/editor/command_line_tutorial.rst @@ -43,17 +43,19 @@ given build type. **General options** -+----------------------------+-----------------------------------------------------------------------------+ -| Command | Description | -+----------------------------+-----------------------------------------------------------------------------+ -| ``-h``, ``--help`` | |release| Display the list of command line options. | -+----------------------------+-----------------------------------------------------------------------------+ -| ``--version`` | |release| Display the version string. | -+----------------------------+-----------------------------------------------------------------------------+ -| ``-v``, ``--verbose`` | |release| Use verbose stdout mode. | -+----------------------------+-----------------------------------------------------------------------------+ -| ``-q``, ``--quiet`` | |release| Quiet mode, silences stdout messages. Errors are still displayed. | -+----------------------------+-----------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------+ +| Command | Description | ++----------------------------+-------------------------------------------------------------------------------+ +| ``-h``, ``--help`` | |release| Display the list of command line options. | ++----------------------------+-------------------------------------------------------------------------------+ +| ``--version`` | |release| Display the version string. | ++----------------------------+-------------------------------------------------------------------------------+ +| ``-v``, ``--verbose`` | |release| Use verbose stdout mode. | ++----------------------------+-------------------------------------------------------------------------------+ +| ``-q``, ``--quiet`` | |release| Quiet mode, silences stdout messages. Errors are still displayed. | ++----------------------------+-------------------------------------------------------------------------------+ +| ``--no-header`` | |release| Do not print engine version and rendering method header on startup. | ++----------------------------+-------------------------------------------------------------------------------+ **Run options** @@ -66,6 +68,9 @@ given build type. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``-p``, ``--project-manager`` | |editor| Start the Project Manager, even if a project is auto-detected. | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--recovery-mode`` | |editor| "Start the editor in recovery mode, which disables features that can typically cause startup crashes, such as tool scripts, editor plugins, | +| | GDExtension addons, and others. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--debug-server `` | |editor| Start the editor debug server (``://[:]``, e.g. ``tcp://127.0.0.1:6007``) | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--dap-port `` | |editor| Use the specified port for the GDScript Debug Adapter Protocol. Recommended port range ``[1024, 49151]``. | @@ -81,6 +86,8 @@ given build type. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--path `` | |release| Path to a project (```` must contain a 'project.godot' file). | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``scene `` | |release| Path or UID of a scene in the project that should be started. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``-u``, ``--upwards`` | |release| Scan folders upwards for 'project.godot' file. | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--main-pack `` | |release| Path to a pack (.pck) file to load. | @@ -96,6 +103,9 @@ given build type. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--display-driver `` | |release| Display driver (and rendering driver). Use ``--help`` first to display the list of available drivers. | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--audio-output-latency`` | |release| Override audio output latency in milliseconds (default is 15 ms). Lower values make sound playback more reactive but increase CPU usage, and may | +| | result in audio cracking if the CPU can't keep up | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--rendering-method `` | |release| Renderer name. Requires driver support. | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--rendering-driver `` | |release| Rendering driver (depends on display driver). Use ``--help`` first to display the list of available drivers. | @@ -108,6 +118,9 @@ given build type. +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--headless`` | |release| Enable headless mode (``--display-driver headless --audio-driver Dummy``). Useful for servers and with ``--script``. | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--log-file`` | |release| Write output/error log to the specified path instead of the default location defined by the project. path should be absolute or relative to | +| | the project directory. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``--write-movie `` | |release| Run the engine in a way that a movie is written (usually with .avi or .png extension). | | | ``--fixed-fps`` is forced when enabled, but can be used to change movie FPS. | | | ``--disable-vsync`` can speed up movie writing but makes interaction more difficult. | @@ -137,6 +150,11 @@ given build type. +------------------------------------+----------------------------------------------------------------------------+ | ``--xr-mode `` | |release| Select XR mode ('default', 'off', 'on'). | +------------------------------------+----------------------------------------------------------------------------+ +| ``--wid `` | |release| Request parented to window. | ++------------------------------------+----------------------------------------------------------------------------+ +| ``--accessibility `` | |release| Select accessibility mode ['auto' (when screen reader is running,| +| | default), 'always', 'disabled']. | ++------------------------------------+----------------------------------------------------------------------------+ **Debug options** @@ -147,6 +165,8 @@ given build type. +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``-b``, ``--breakpoints`` | |release| Breakpoint list as source::line comma-separated pairs, no spaces (use ``%20`` instead). | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--ignore-error-breaks`` | |release| If debugger is connected, prevents sending error breakpoints. | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--profiling`` | |release| Enable profiling in the script debugger. | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--gpu-profile`` | |release| Show a GPU profile of the tasks that took the most time during frame rendering. | @@ -155,6 +175,16 @@ given build type. +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--gpu-abort`` | |debug| Abort on GPU errors (usually validation layer errors), may help see the problem if your system freezes. | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--generate-spirv-debug-info``| |debug| Generate SPIR-V debug information. This allows source-level shader debugging with RenderDoc. | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--extra-gpu-memory-tracking``| |debug| Enables additional memory tracking (see class reference for | +| | `RenderingDevice.get_driver_and_device_memory_report()` and linked methods). Currently only implemented for | +| | Vulkan. Enabling this feature may cause crashes on some systems due to buggy drivers or bugs in the Vulkan | +| | Loader. See https://github.com/godotengine/godot/issues/95967 | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--accurate-breadcrumbs`` | |debug| Force barriers between breadcrumbs. Useful for narrowing down a command causing GPU resets. Currently | +| | only implemented for Vulkan. | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--remote-debug `` | |release| Remote debug (``://[:]``, e.g. ``tcp://127.0.0.1:6007``). | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--single-threaded-scene`` | |release| Scene tree runs in single-threaded mode. Sub-thread groups are disabled and run on the main thread. | @@ -169,7 +199,14 @@ given build type. +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--debug-stringnames`` | |debug| Print all StringName allocations to stdout when the engine quits. | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| ``--frame-delay `` | |release| Simulate high CPU load (delay each frame by milliseconds). | +| ``--debug-canvas-item-redraw`` | |debug| Display a rectangle each time a canvas item requests a redraw (useful to troubleshoot low processor | +| | mode). | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--max-fps `` | |release| Set a maximum number of frames per second rendered (can be used to limit power usage). A value of 0 | +| | results in unlimited framerate. | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--frame-delay `` | |release| Simulate high CPU load (delay each frame by milliseconds). Do not use as a FPS limiter; use | +| | --max-fps instead. | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--time-scale `` | |release| Force time scale (higher values are faster, 1.0 is normal speed). | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ @@ -186,6 +223,8 @@ given build type. +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ | ``--print-fps`` | |release| Print the frames per second to the stdout. | +--------------------------------+-----------------------------------------------------------------------------------------------------------------+ +| ``--editor-pseudolocalization``| |editor| Enable pseudolocalization for the editor and the project manager. | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------+ **Standalone tools** @@ -195,19 +234,27 @@ given build type. | ``-s``, ``--script