Browse Source

Update command line project exporting instructions

Hugo Locurcio 3 years ago
parent
commit
be31dd4020
1 changed files with 17 additions and 6 deletions
  1. 17 6
      tutorials/export/exporting_projects.rst

+ 17 - 6
tutorials/export/exporting_projects.rst

@@ -141,20 +141,31 @@ the export parameters. A basic invocation of the command would be:
     godot --export "Windows Desktop" some_name
     godot --export "Windows Desktop" some_name
 
 
 This will export to ``some_name.exe``, assuming there is a preset
 This will export to ``some_name.exe``, assuming there is a preset
-called "Windows Desktop" and the template can be found.
+called "Windows Desktop" and the template can be found. (The export preset name
+must be written within quotes if it contains spaces or special characters.)
 The output path is relative to the project path or absolute;
 The output path is relative to the project path or absolute;
 it does not respect the directory the command was invoked from.
 it does not respect the directory the command was invoked from.
 
 
-You can also configure it to export only the PCK or ZIP file, allowing
-a single export to be used with multiple Godot executables.
-This takes place if the target name ends with ``.pck`` or ``.zip``.
+You can also configure it to export *only* the PCK or ZIP file, allowing
+a single exported main pack file to be used with multiple Godot executables.
+When doing so, the export preset name must still be specified on the command line:
+
+.. code-block:: shell
+
+    godot --export-pack "Windows Desktop" some_name.pck
 
 
 It is often useful to combine the ``--export`` flag with the ``--path``
 It is often useful to combine the ``--export`` flag with the ``--path``
-flag, and to create a dedicated export preset for automated export:
+flag, so that you do not need to ``cd`` to the project folder before running
+the command:
 
 
 .. code-block:: shell
 .. code-block:: shell
 
 
-    godot --path path/to/project --export "pck" game_name.pck
+    godot --path /path/to/project --export "Windows Desktop" some_name
+
+.. seealso::
+
+    See :ref:`doc_command_line_tutorial` for more information about using Godot
+    from the command line.
 
 
 PCK versus ZIP pack file formats
 PCK versus ZIP pack file formats
 --------------------------------
 --------------------------------