Skip to content

Commit a63a33a

Browse files
authored
Merge pull request godotengine#8586 from jonri/patch-1
Clarify path usage for command line options
2 parents ae8ef84 + ffe017a commit a63a33a

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

tutorials/editor/command_line_tutorial.rst

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -264,14 +264,14 @@ Depending on where your Godot binary is located and what your current
264264
working directory is, you may need to set the path to your project
265265
for any of the following commands to work correctly.
266266

267-
This can be done by giving the path to the ``project.godot`` file
267+
When running the editor, this can be done by giving the path to the ``project.godot`` file
268268
of your project as either the first argument, like this:
269269

270270
::
271271

272272
godot path_to_your_project/project.godot [other] [commands] [and] [args]
273273

274-
Or by using the ``--path`` argument:
274+
For all commands, this can be done by using the ``--path`` argument:
275275

276276
::
277277

@@ -283,6 +283,17 @@ For example, the full command for exporting your game (as explained below) might
283283

284284
godot --headless --path path_to_your_project --export-release my_export_preset_name game.exe
285285

286+
When starting from a subdirectory of your project, use the ``--upwards`` argument for Godot to
287+
automatically find the ``project.godot`` file by recursively searching the parent directories.
288+
289+
For example, running a scene (as explained below) nested in a subdirectory might look like this
290+
when your working directory is in the same path:
291+
292+
::
293+
294+
godot --upwards nested_scene.tscn
295+
296+
286297
..
287298
288299
Creating a project
@@ -307,13 +318,15 @@ Running the editor
307318
------------------
308319

309320
Running the editor is done by executing Godot with the ``-e`` flag. This
310-
must be done from within the project directory or a subdirectory,
321+
must be done from within the project directory or by setting the project path as explained above,
311322
otherwise the command is ignored and the Project Manager appears.
312323

313324
::
314325

315326
godot -e
316327

328+
When passing in the full path to the ``project.godot`` file, the ``-e`` flag may be omitted.
329+
317330
If a scene has been created and saved, it can be edited later by running
318331
the same code with that scene as argument.
319332

@@ -335,15 +348,15 @@ Otherwise, an error will be thrown upon opening the project.
335348
Running the game
336349
----------------
337350

338-
To run the game, simply execute Godot within the project directory or
339-
subdirectory.
351+
To run the game, execute Godot within the project directory or with the project path as explained above.
340352

341353
::
342354

343355
godot
344356

345-
When a specific scene needs to be tested, pass that scene to the command
346-
line.
357+
Note that passing in the ``project.godot`` file will always run the editor instead of running the game.
358+
359+
When a specific scene needs to be tested, pass that scene to the command line.
347360

348361
::
349362

0 commit comments

Comments
 (0)