Samouczek wiersza poleceń¶
Some developers like using the command line extensively. Godot is designed to be friendly to them, so here are the steps for working entirely from the command line. Given the engine relies on almost no external libraries, initialization times are pretty fast, making it suitable for this workflow.
Informacja
On Windows and Linux, you can run a Godot binary in a terminal by specifying its relative or absolute path.
On macOS, the process is different due to Godot being contained within an
.app
bundle (which is a folder, not a file). To run a Godot binary
from a terminal on macOS, you have to cd
to the folder where the Godot
application bundle is located, then run Godot.app/Contents/MacOS/Godot
followed by any command line arguments. If you've renamed the application
bundle from Godot
to another name, make sure to edit this command line
accordingly.
Command line reference¶
General options
Command |
Opis |
|
Eksportowanie do sieci Web. |
|
Display the version string. |
|
Use verbose stdout mode. |
|
Quiet mode, silences stdout messages. Errors are still displayed. |
Run options
Command |
Opis |
|
Start the editor instead of running the scene (tools must be enabled). |
|
Start the project manager, even if a project is auto-detected (tools must be enabled). |
|
Tworzenie pierwszej broni. |
|
Use a specific locale (<locale> being a two-letter code). See Języki for more details. |
|
Path to a project (<directory> must contain a 'project.godot' file). |
|
Scan folders upwards for 'project.godot' file. |
|
Path to a pack (.pck) file to load. |
|
Render thread mode ('unsafe', 'safe', 'separate'). See Thread Model for more details. |
|
Remote filesystem ( |
|
Audio driver. Use |
|
Video driver. Use |
Display options
Command |
Opis |
|
Request fullscreen mode. |
|
Request a maximized window. |
|
Tryby renderowania. |
|
Request an always-on-top window. |
|
Wiele rozdzielczości. |
|
Request window position. |
|
Force low-DPI mode (macOS and Windows only). |
|
Run with invisible window. Useful together with |
Debug options
Informacja
Debug options are only available in the editor and debug export templates
(they require debug
or release_debug
build targets, see
Cel for more details).
Command |
Opis |
|
Debug (local stdout debugger). |
|
Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead). |
|
Enable profiling in the script debugger. |
|
Remote debug ( |
|
Show collision shapes when running the scene. |
|
Show navigation polygons when running the scene. |
|
Simulate high CPU load (delay each frame by <ms> milliseconds). |
|
Force time scale (higher values are faster, 1.0 is normal speed). |
|
Disable render loop so rendering only occurs when called explicitly from script. |
|
Disable crash handler when supported by the platform code. |
|
Force a fixed number of frames per second. This setting disables real-time synchronization. |
|
Print the frames per second to the stdout. |
Standalone tools
Command |
Opis |
|
Uruchomienie skryptu. |
|
Only parse for errors and quit (use with |
|
Export the project using the given export target. Export only main pack if path ends with .pck or .zip (tools must be enabled). |
|
Like |
|
Dump the engine API reference to the given <path> in XML format, merging if existing files are found (tools must be enabled). |
|
Disallow dumping the base types (used with |
|
Build the scripting solutions (e.g. for C# projects, tools must be enabled). |
|
Generate JSON dump of the Godot API for GDNative bindings (tools must be enabled). |
|
Run a unit test. Use |
|
Like |
Ścieżka¶
It is recommended that your Godot binary be in your PATH environment
variable, so it can be executed easily from any place by typing
godot
. You can do so on Linux by placing the Godot binary in
/usr/local/bin
and making sure it is called godot
.
Ustawienie ścieżki projektu¶
W zależności od tego, gdzie znajdują się twoje binarne Godota i jaki jest twój aktualny katalog roboczy, być może będziesz musiał wstawić ścieżkę do projektu, aby jedno z poniższych poleceń działało poprawnie.
Można to zrobić, podając ścieżkę do pliku ``project.godot``w swoim projekcie jako pierwszy argument, taki jak ten:
godot path_to_your_project/project.godot [other] [commands] [and] [args]
Lub używając argumentu --path
:
godot --path path_to_your_project [other] [commands] [and] [args]
Na przykład, pełna komenda eksportowania gry (jak wyjaśniono poniżej) może wyglądać tak:
godot --path path_to_your_project --export my_export_preset_name game.exe
Tworzenie projektu¶
Utworzenie projektu z wiersza poleceń można wykonać poprzez nawigację po powłoce w żądane miejsce i utworzenie pliku project.godot.
mkdir newgame
cd newgame
touch project.godot
Projekt można teraz otworzyć w Godot.
Uruchamianie edytora¶
Running the editor is done by executing Godot with the -e
flag. This
must be done from within the project directory or a subdirectory,
otherwise the command is ignored and the project manager appears.
godot -e
Jeśli scena została utworzona i zapisana, można ją później edytować, używając tego samego kodu z sceną jako argument.
godot -e scene.tscn
Usuwanie sceny¶
Godot jest przyjaźnie nastawiony do twojego systemu plików i nie będzie tworzył dodatkowych plików metadanych. Użyj rm
aby skasować plik sceny. Upewnij się, że nic nie odnosi się do sceny albo błąd zostanie wyrzucony przy otwieraniu.
rm scene.tscn
Uruchamianie gry¶
Aby uruchomić grę, wystarczy uruchomić Godota w katalogu lub podkatalogu projektu.
godot
Gdy zachodzi potrzeba przetestowania określonej sceny, należy przekazać ją do wiersza poleceń.
godot scene.tscn
Debugowanie¶
Catching errors in the command line can be a difficult task because they
just fly by. For this, a command line debugger is provided by adding
-d
. It works for running either the game or a simple scene.
godot -d
godot -d scene.tscn
Eksportowanie¶
Wspierane jest eksportowanie projektu z wiersza poleceń. Jest to szczególnie przydatne w przypadku ciągłej integracji. Wersja Godota, która jest bezgłowa (budowa serwerów, brak wideo) jest idealna do tego celu.
godot --export "Linux/X11" /var/builds/project
godot --export Android /var/builds/project.apk
The preset name must match the name of an export preset defined in the
project's export_presets.cfg
file. If the preset name contains spaces or
special characters (such as "Windows Desktop"), it must be surrounded with quotes.
Aby wyeksportować debugowaną wersję gry, użyj przełącznika -export-debug
zamiast -export
. Ich parametry i zastosowanie są takie 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.
Ostrzeżenie
When specifying a relative path as the path for --export, --export-debug
or --export-pack, the path will be relative to the directory containing
the project.godot
file, not relative to the current working directory.
Uruchomienie skryptu¶
It is possible to run a simple .gd
script from the command line.
This feature is especially useful in large projects, e.g. for batch
conversion of assets or custom import/export.
The script must inherit from SceneTree
or MainLoop
.
Here is a simple sayhello.gd
example of how it works:
#!/usr/bin/env -S godot -s
extends SceneTree
func _init():
print("Hello!")
quit()
I jak go uruchomić:
# Prints "Hello!" to standard output.
godot -s sayhello.gd
If no project.godot
exists at the path, current path is assumed to be the
current working directory (unless --path
is specified).
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
distributions, as well as macOS:
# Mark script as executable.
chmod +x sayhello.gd
# Prints "Hello!" to standard output.
./sayhello.gd
If the above doesn't work in your current version of Linux or macOS, you can always have the shebang run Godot straight from where it is located as follows:
#!/usr/bin/godot -s