Використання командного рядка
Деякі розробники люблять широко використовувати командний рядок. Godot розроблений так, щоб бути дружелюбним до них, тому ось кроки для роботи виключно з командного рядка. З огляду на те, що движок майже не має зовнішніх бібліотек, час ініціалізації досить швидкий, що робить його придатним для цього робочого процесу.
Примітка
В Windows і Linux, ви можете запустити бінарник Godot в терміналі, вказавши його відносний, чи точний, шлях.
На macOS, процес відрізняється, через те, що Godot міститься в .app (який є текою, а не файлом). Щоб запустити бінарний файл Godot з терміналу на macOS, ви маєте з допомогою команди cd перейти до теки розміщення Godot, а потім запустити його вказавши Godot.app/Contents/MacOS/Godot в командному рядку. Якщо ви перейменували теку з Godot, то переконайтеся, що ввели відповідне ім'я.
Команди командного рядка
Легенда
Доступно в збірках редакторів, шаблонах експорту налагодження та випуску шаблонів експорту.
Доступно лише для збірок редакторів і шаблонів експорту налагодження.
Доступно лише в збірках редактора.
Зауважте, що невідомі аргументи командного рядка не мають ніякого ефекту. Механізм не попереджатиме вас про використання аргументу командного рядка, який не існує з даним типом збірки.
Загальні команди
Команда |
Опис |
|
|
|
|
|
|
|
|
Команди запуску
Команда |
Опис |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Команди відображення
Команда |
Опис |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Команди налагодження
Команда |
Опис |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Автономні інструменти
Команда |
Опис |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Шлях
Рекомендовано розмістити двійковий файл редактора Godot у змінній середовища PATH, щоб його можна було легко виконати з будь-якого місця, ввівши godot. Ви можете зробити це в Linux, помістивши двійковий файл Godot у /usr/local/bin і переконавшись, що він називається godot (з урахуванням регістру).
Щоб легко досягти цього в Windows або macOS, ви можете встановити Godot за допомогою Scoop (у Windows) або Homebrew (у macOS). Це автоматично зробить встановлену копію Godot доступною в PATH:
# Add "Extras" bucket
scoop bucket add extras
# Standard editor:
scoop install godot
# Editor with C# support (will be available as `godot-mono` in `PATH`):
scoop install godot-mono
# Standard editor:
brew install godot
# Editor with C# support (will be available as `godot-mono` in `PATH`):
brew install godot-mono
Налаштування шляху проєкта
Залежно від того, де розміщений ваш бінарний файл Godot та який ваш поточний робочий каталог, вам може знадобитися встановити шлях до вашого проєкту, щоб будь-яка з наступних команд працювала правильно.
Під час запуску редактора це можна зробити, вказавши шлях до файлу project.godot вашого проекту як перший аргумент, наприклад:
godot path_to_your_project/project.godot [other] [commands] [and] [args]
Для всіх команд це можна зробити за допомогою аргументу --path:
godot --path path_to_your_project [other] [commands] [and] [args]
Наприклад, повна команда експорту вашої гри (описано нижче) може виглядати так:
godot --headless --path path_to_your_project --export-release my_export_preset_name game.exe
Починаючи з підкаталогу вашого проекту, використовуйте аргумент --upwards для Godot, щоб автоматично знайти файл project.godot шляхом рекурсивного пошуку в батьківських каталогах.
Наприклад, запуск сцени (як пояснюється нижче), вкладеної в підкаталог, може виглядати так, якщо ваш робочий каталог знаходиться в тому самому шляху:
godot --upwards nested_scene.tscn
Як створити проєкт
Створити проект із командного рядка можна, перейшовши в оболонку до потрібного місця та створивши файл project.godot.
mkdir newgame
cd newgame
touch project.godot
Тепер проєкт можна відкрити в Godot.
Запуск редактора
Запуск редактора виконується виконанням Godot з прапорцем -e. Це потрібно зробити з каталогу проекту або шляхом встановлення шляху до проекту, як пояснено вище, інакше команда ігнорується та з’являється менеджер проекту.
godot -e
Під час передачі повного шляху до файлу project.godot прапор -e можна опустити.
Якщо сцена була створена та збережена, її можна буде відредагувати пізніше, запустивши той самий код із цією сценою в якості аргумента.
godot -e scene.tscn
Видаляння сцени
Godot дружить з вашою файловою системою і не буде створювати додаткові файли метаданих. Використовуйте rm, щоб стерти файл сцени. Переконайтеся, що ніщо не посилається на цю сцену. Інакше під час відкриття проекту буде видано повідомлення про помилку.
rm scene.tscn
Запуск гри
Щоб запустити гру, виконайте Godot у каталозі проекту або за допомогою шляху проекту, як описано вище.
godot
Зауважте, що передавання файлу project.godot завжди запускатиме редактор замість запуску гри.
Коли певну сцену потрібно протестувати, передайте її в командний рядок.
godot scene.tscn
Діагностика
Виявлення помилок у командному рядку може бути важким завданням, оскільки вони швидко прокручуються. Для цього налагоджувач командного рядка забезпечується додаванням -d. Він працює для запуску гри або окремої сцени.
godot -d
godot -d scene.tscn
Експортування
Також підтримується експорт проекту з командного рядка. Це особливо корисно для налаштувань постійної інтеграції.
Примітка
Використання аргументу командного рядка --headless є обов’язковим на платформах, які не мають доступу до GPU (наприклад, безперервна інтеграція). На платформах із доступом до GPU --headless запобігає появі вікна під час експорту проекту.
# `godot` must be a Godot editor binary, not an export template.
# Also, export templates must be installed for the editor
# (or a valid custom export template must be defined in the export preset).
godot --headless --export-release "Linux/X11" /var/builds/project
godot --headless --export-release Android /var/builds/project.apk
Назва попередньо встановлених налаштувань має відповідати назві попередньо встановлених параметрів експорту, визначених у файлі проєкту export_presets.cfg. Якщо попередньо встановлена назва містить пробіли, чи спеціальні символи (наприклад, "Windows Desktop"), то вона повинна бути загорнута в лапки.
Щоб експортувати налагоджену версію гри, використовуйте перемикач --export-debug замість --export-release. Їх параметри та використання однакові.
Щоб експортувати лише файл PCK, використовуйте опцію --export-pack, за якою слід попередньо встановлене ім’я та вихідний шлях із розширенням файлу, замість --export-release або --export -debug``. Розширення вихідного шляху визначає формат пакета, PCK або ZIP.
Попередження
Якщо вказати відносний шлях як шлях для --export-release, --export-debug або --export-pack, шлях буде відносним до каталогу, що містить ` файл project.godot`, не відносно поточного робочого каталогу.
Запуск скрипта
Сценарій .gd можна запустити з командного рядка. Ця функція особливо корисна у великих проектах, напр. для пакетного перетворення активів або спеціального імпорту/експорту.
Скрипт повинен успадковуватись від SceneTree (Дерева сцен), або MainLoop (Головного циклу).
Ось приклад sayhello.gd, який показує, як це працює:
#!/usr/bin/env -S godot -s
extends SceneTree
func _init():
print("Hello!")
quit()
І як це запустити:
# Prints "Hello!" to standard output.
godot -s sayhello.gd
Якщо по шляху немає жодного project.godot, поточний шлях вважається поточним робочим каталогом (якщо не вказано --path).
Шлях сценарію буде інтерпретовано як шлях ресурсу відносно проекту, тут res://sayhello.gd. Ви також можете використовувати замість цього абсолютний шлях до файлової системи, що корисно, якщо сценарій знаходиться поза каталогом проекту.
Перший рядок sayhello.gd вище зазвичай називають шебангом. Якщо бінарник Godot є у вашому PATH як godot, це дозволяє вам запускати скрипт, в сучасних дистрибутивах Linux, а також macOS:
# Mark script as executable.
chmod +x sayhello.gd
# Prints "Hello!" to standard output.
./sayhello.gd
Якщо вищевказане не працює у вашій поточній версії Linux, або macOS, ви завжди можете запустити шебанг Godot прямо звідти, де він знаходиться наступним чином:
#!/usr/bin/godot -s