godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-08 10:10:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3973 from Calinou/update-command-line-tutorial

Browse Source 
Update the command line tutorial with the options currently in `master`
This commit is contained in:
Nathan Lovato
2020-09-06 08:43:39 -06:00
committed by GitHub
parent 1cd84e46fa cadf87ca40
commit 3d893be4a3
1 changed files with 91 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
getting_started/editor/command_line_tutorial.rst
View File

@@ -51,32 +51,44 @@ Command line reference
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--remote-fs <address>`` | Remote filesystem (``<host/IP>[:<port>]`` address). |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--remote-fs-password <password>`` | Password for remote filesystem. |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--audio-driver <driver>`` | Audio driver. Use ``--help`` first to display the list of available drivers. |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--video-driver <driver>`` | Video driver. Use ``--help`` first to display the list of available drivers. |
| ``--display-driver <driver>`` | Display driver (and rendering driver). Use ``--help`` first to display the list of available drivers. |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--rendering-driver <driver>`` | Rendering driver (depends on display 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 <W>x<H>`` | Request window resolution. |
+-----------------------------+----------------------------------------------------------------------------+
| ``--position <X>,<Y>`` | Request window position. |
+-----------------------------+----------------------------------------------------------------------------+
| ``--low-dpi`` | Force low-DPI mode (macOS and Windows only). |
+-----------------------------+----------------------------------------------------------------------------+
| ``--no-window`` | Disable window creation (Windows only). Useful together with ``--script``. |
+-----------------------------+----------------------------------------------------------------------------+
+------------------------------------+----------------------------------------------------------------------------+
| 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 <W>x<H>`` | Request window resolution. |
+------------------------------------+----------------------------------------------------------------------------+
| ``--position <X>,<Y>`` | Request window position. |
+------------------------------------+----------------------------------------------------------------------------+
| ``--low-dpi`` | Force low-DPI mode (macOS and Windows only). |
+------------------------------------+----------------------------------------------------------------------------+
| ``--no-window`` | Disable window creation (Windows only). Useful together with ``--script``. |
+------------------------------------+----------------------------------------------------------------------------+
| ``--enable-vsync-via-compositor`` | When vsync is enabled, vsync via the OS' window compositor (Windows only). |
+------------------------------------+----------------------------------------------------------------------------+
| ``--disable-vsync-via-compositor`` | Disable vsync via the OS' window compositor (Windows only). |
+------------------------------------+----------------------------------------------------------------------------+
| ``--single-window`` | Use a single window (no separate subwindows). |
+------------------------------------+----------------------------------------------------------------------------+
| ``--tablet-driver`` | Tablet input driver (Windows only). |
+------------------------------------+----------------------------------------------------------------------------+
**Debug options**
@@ -86,57 +98,64 @@ Command line reference
(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 <address>`` | Remote debug (``<host/IP>:<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. |
+------------------------------+---------------------------------------------------------------------------------------------+
+------------------------------+---------------------------------------------------------------------------------------------------------+
| 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. |
+------------------------------+---------------------------------------------------------------------------------------------------------+
| ``--gpu-abort`` | Abort on GPU errors (usually validation layer errors), may help see the problem if your system freezes. |
+------------------------------+---------------------------------------------------------------------------------------------------------+
| ``--remote-debug <address>`` | Remote debug (<protocol>://<host/IP>[:<port>], e.g. tcp://127.0.0.1:6007). |
+------------------------------+---------------------------------------------------------------------------------------------------------+
| ``--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 <script>``, ``--script <script>`` | Run a script. |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--check-only`` | Only parse for errors and quit (use with ``--script``). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export <target>`` | Export the project using the given export target. Export only main pack if path ends with .pck or .zip (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export-debug <target>`` | Like ``--export``, but use debug template (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--doctool <path>`` | Dump the engine API reference to the given <path> in XML format, merging if existing files are found (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-docbase`` | Disallow dumping the base types (used with ``--doctool``, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--build-solutions`` | Build the scripting solutions (e.g. for C# projects, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--gdnative-generate-json-api`` | Generate JSON dump of the Godot API for GDNative bindings (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--test <test>`` | Run a unit test. Use ``--help`` first to display the list of tests. (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| Command | Description |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-s <script>``, ``--script <script>`` | Run a script. |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--check-only`` | Only parse for errors and quit (use with ``--script``). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export <preset> <path>`` | Export the project using the given export target. Export only main pack if path ends with .pck or .zip |
| | (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export-debug <preset> <path>`` | Like ``--export``, but use debug template (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--export-pack <preset> <path>`` | Like ``--export``, but only export the game pack for the given preset. The <path> extension determines whether it will be in PCK or ZIP format. |
| | (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--doctool <path>`` | Dump the engine API reference to the given <path> in XML format, merging if existing files are found |
| | (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--no-docbase`` | Disallow dumping the base types (used with ``--doctool``, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--build-solutions`` | Build the scripting solutions (e.g. for C# projects, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--gdnative-generate-json-api`` | Generate JSON dump of the Godot API for GDNative bindings (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--test <test>`` | Run a unit test. Use ``--help`` first to display the list of tests. (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
Path
----
@@ -274,6 +293,10 @@ will be shown.
To export a debug version of the game, use the ``--export-debug`` switch
instead of ``--export``. Their parameters and usage are the same.
To export only a PCK file, use the ``--export-pack`` option followed by the
preset name and output path, with the file extension, instead of ``--export``.
The output path extension determines the package's format, either PCK or ZIP.
Running a script
----------------