diff --git a/development/compiling/introduction_to_the_buildsystem.rst b/development/compiling/introduction_to_the_buildsystem.rst index c83a06eda..b7993ddc9 100644 --- a/development/compiling/introduction_to_the_buildsystem.rst +++ b/development/compiling/introduction_to_the_buildsystem.rst @@ -122,6 +122,8 @@ you can build them yourself). Aside from that, there are a few standard options that can be set in all build targets, and which will be explained below. +.. _doc_introduction_to_the_buildsystem_tools: + Tools ----- @@ -134,6 +136,8 @@ manager. scons platform= tools=yes/no +.. _doc_introduction_to_the_buildsystem_target: + Target ------ diff --git a/getting_started/editor/command_line_tutorial.rst b/getting_started/editor/command_line_tutorial.rst index 15bb478b7..5020ce41a 100644 --- a/getting_started/editor/command_line_tutorial.rst +++ b/getting_started/editor/command_line_tutorial.rst @@ -11,6 +11,133 @@ entirely from the command line. Given the engine relies on almost no external libraries, initialization times are pretty fast, making it suitable for this workflow. +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. | ++----------------------------+----------------------------------------------------------------------+ + +**Run options** + ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Command | Description | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``-e``, ``--editor`` | Start the editor instead of running the scene (:ref:`tools ` must be enabled). | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``-p``, ``--project-manager`` | Start the project manager, even if a project is auto-detected (:ref:`tools ` must be enabled). | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``-q``, ``--quit`` | Quit after the first iteration. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``-l ``, ``--language `` | Use a specific locale ( being a two-letter code). See :ref:`doc_locales` for more details. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--path `` | Path to a project ( must contain a 'project.godot' file). | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``-u``, ``--upwards`` | Scan folders upwards for 'project.godot' file. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--main-pack `` | Path to a pack (.pck) file to load. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--render-thread `` | Render thread mode ('unsafe', 'safe', 'separate'). See :ref:`Thread Model ` for more details. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--remote-fs
`` | Remote filesystem (``[:]`` address). | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--audio-driver `` | Audio driver. Use ``--help`` first to display the list of available drivers. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ``--video-driver `` | Video driver. Use ``--help`` first to display the list of available drivers. | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Display options** + ++-----------------------------+----------------------------------------------------------------------------+ +| Command | Description | ++-----------------------------+----------------------------------------------------------------------------+ +| ``-f``, ``--fullscreen`` | Request fullscreen mode. | ++-----------------------------+----------------------------------------------------------------------------+ +| ``-m``, ``--maximized`` | Request a maximized window. | ++-----------------------------+----------------------------------------------------------------------------+ +| ``-w``, ``--windowed`` | Request windowed mode. | ++-----------------------------+----------------------------------------------------------------------------+ +| ``-t``, ``--always-on-top`` | Request an always-on-top window. | ++-----------------------------+----------------------------------------------------------------------------+ +| ``--resolution x`` | Request window resolution. | ++-----------------------------+----------------------------------------------------------------------------+ +| ``--position ,`` | Request window position. | ++-----------------------------+----------------------------------------------------------------------------+ +| ``--low-dpi`` | Force low-DPI mode (macOS and Windows only). | ++-----------------------------+----------------------------------------------------------------------------+ +| ``--no-window`` | Disable window creation (Windows only). 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 + :ref:`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
`` | Remote debug (``:`` address). | ++------------------------------+---------------------------------------------------------------------------------------------+ +| ``--debug-collisions`` | Show collision shapes when running the scene. | ++------------------------------+---------------------------------------------------------------------------------------------+ +| ``--debug-navigation`` | Show navigation polygons when running the scene. | ++------------------------------+---------------------------------------------------------------------------------------------+ +| ``--frame-delay `` | Simulate high CPU load (delay each frame by milliseconds). | ++------------------------------+---------------------------------------------------------------------------------------------+ +| ``--time-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 `` | 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