Skip to content

Commit 028a66a

Browse files
authored
Merge pull request #7419 from Calinou/command-line-tutorial-export-headless
2 parents 37fe448 + 06c6c3c commit 028a66a

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

tutorials/editor/command_line_tutorial.rst

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,9 @@ For example, the full command for exporting your game (as explained below) might
237237

238238
::
239239

240-
godot --path path_to_your_project --export-release my_export_preset_name game.exe
240+
godot --headless --path path_to_your_project --export-release my_export_preset_name game.exe
241+
242+
..
241243
242244
Creating a project
243245
------------------
@@ -324,27 +326,34 @@ Exporting
324326
---------
325327

326328
Exporting the project from the command line is also supported. This is
327-
especially useful for continuous integration setups. The version of Godot
328-
that is headless (server build, no video) is ideal for this.
329+
especially useful for continuous integration setups.
330+
331+
.. note::
332+
333+
Using the ``--headless`` command line argument is **required** on platforms
334+
that do not have GPU access (such as continuous integration). On platforms
335+
with GPU access, ``--headless`` prevents a window from spawning while the
336+
project is exporting.
329337

330338
::
331339

332340
# `godot` must be a Godot editor binary, not an export template.
333341
# Also, export templates must be installed for the editor
334342
# (or a valid custom export template must be defined in the export preset).
335-
godot --export-release "Linux/X11" /var/builds/project
336-
godot --export-release Android /var/builds/project.apk
343+
godot --headless --export-release "Linux/X11" /var/builds/project
344+
godot --headless --export-release Android /var/builds/project.apk
337345

338346
The preset name must match the name of an export preset defined in the
339347
project's ``export_presets.cfg`` file. If the preset name contains spaces or
340348
special characters (such as "Windows Desktop"), it must be surrounded with quotes.
341349

342-
To export a debug version of the game, use the ``--export-debug`` switch
343-
instead of ``--export``. Their parameters and usage are the same.
350+
To export a debug version of the game, use the ``--export-debug`` switch instead
351+
of ``--export-release``. Their parameters and usage are the same.
344352

345353
To export only a PCK file, use the ``--export-pack`` option followed by the
346-
preset name and output path, with the file extension, instead of ``--export``.
347-
The output path extension determines the package's format, either PCK or ZIP.
354+
preset name and output path, with the file extension, instead of
355+
``--export-release`` or ``--export-debug``. The output path extension determines
356+
the package's format, either PCK or ZIP.
348357

349358
.. warning::
350359

0 commit comments

Comments
 (0)