stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 19:29:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarified --script <script> expected path values (#9923)

Browse Source 
* Clarified expected path value for `--script`

Clarified the kind of paths expected by `--script` and how they are interpreted. [Silent errors in recent Godot versions (regressions)](godotengine/godot#96691) made this even more confusing.

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
This commit is contained in:
Klaim (Joël Lamotte)
2024-11-17 12:09:34 +01:00
committed by GitHub
co-authored by A Thousand Ships
parent 9a2fccb54b
commit 73f306f6b0
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tutorials/editor/command_line_tutorial.rst
+11 -5
View File
@@ -188,7 +188,8 @@ given build type.
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Command | Description |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``-s``, ``--script <script>`` | |release| Run a script. |
| ``-s``, ``--script <script>`` | |release| Run a script. ``<script>`` must be a resource path relative to the project (``myscript.gd`` will be interpreted as ``res://myscript.gd``) |
| | or an absolute filesystem path (for example on Windows ``C:/tmp/myscript.gd``) |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| ``--check-only`` | |release| Only parse for errors and quit (use with ``--script``). |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -288,15 +289,15 @@ For example, the full command for exporting your game (as explained below) might
godot --headless --path path_to_your_project --export-release my_export_preset_name game.exe
When starting from a subdirectory of your project, use the ``--upwards`` argument for Godot to
When starting from a subdirectory of your project, use the ``--upwards`` argument for Godot to
automatically find the ``project.godot`` file by recursively searching the parent directories.
For example, running a scene (as explained below) nested in a subdirectory might look like this
For example, running a scene (as explained below) nested in a subdirectory might look like this
when your working directory is in the same path:
::
godot --upwards nested_scene.tscn
godot --upwards nested_scene.tscn
..
@@ -353,7 +354,7 @@ Otherwise, an error will be thrown upon opening the project.
Running the game
----------------
To run the game, execute Godot within the project directory or with the project path as explained above.
To run the game, execute Godot within the project directory or with the project path as explained above.
::
@@ -453,6 +454,11 @@ And how to run it:
If no ``project.godot`` exists at the path, current path is assumed to be the
current working directory (unless ``--path`` is specified).
The script path will be interpreted as a resource path relative to
the project, here ``res://sayhello.gd``. You can also use an absolute
filesystem path instead, which is useful if the script is located
outside of the project directory.
The first line of ``sayhello.gd`` above is commonly referred to as
a *shebang*. If the Godot binary is in your ``PATH`` as ``godot``,
it allows you to run the script as follows in modern Linux