Використання командного рядка

Деякі розробники люблять широко використовувати командний рядок. Godot розроблений так, щоб бути дружелюбним до них, тому ось кроки для роботи виключно з командного рядка. З огляду на те, що движок майже не має зовнішніх бібліотек, час ініціалізації досить швидкий, що робить його придатним для цього робочого процесу.

Команди командного рядка

Загальні команди

Команда Опис
-h, --help, /? Виводить список команд командного рядка.
--version Виводить рядок версії.
-v, --verbose Use verbose stdout mode.
--quiet Quiet mode, silences stdout messages. Errors are still displayed.

Команди запуску

Команда Опис
-e, --editor Запускає редактор замість запуску сцени (інструменти повинні бути включені).
-p, --project-manager Запускає керівник проектів, навіть якщо проект виявлено автоматично (інструменти повинні бути включені).
-q, --quit Вийти після першої ітерації.
-l <locale>, --language <locale> Використати спеціальну локаль (<locale> - це двобуквенний код). Дивіться Локалі для більш докладної інформації.
--path <каталог> Шлях до проекту (<directory> повинен містити файл 'project.godot').
-u, --upwards Scan folders upwards for 'project.godot' file.
--main-pack <file> Шлях до файлу пакета (.pck) для завантаження.
--render-thread <mode> Режим рендерінгу ('unsafe' ("небезпечний"), 'safe' ("безпечний"), 'separate' ("окремий")). Докладнішу інформацію дивіться Thread Model.
--remote-fs <address> Віддалена файлова система (<host/IP>[:<port>] адреса).
--audio-driver <driver> Аудіо драйвер. Спершу використовуйте --help для відображення списку доступних драйверів.
--video-driver <driver> Відео драйвер. Спершу використовуйте --help для відображення списку доступних драйверів.

Команди відображення

Команда Опис
-f, --fullscreen Запросити повноекранний режим.
-m, --maximized Запросити максимальне вікно.
-w, --windowed Запросити віконний режим.
-t, --always-on-top Запросити вікно поверх інших вікон.
--resolution <W>x<H> Запросити розширення вікна.
--position <X>,<Y> Запросити позицію вікна.
--low-dpi Force low-DPI mode (macOS and Windows only).
--no-window Вимкнути створення вікон (лише для Windows). Корисно разом із --script.

Команди налагодження

Примітка

Команди налагодження доступні лише в редакторі та шаблонах експорту налагодження (вони вимагають debug, або release_debug, дивіться Призначення для більш детальної інформації).

Команда Опис
-d, --debug Налагодження (локальний налагоджувач stdout).
-b, --breakpoints Список точок розриву в вигляді пар джерело::рядок, розділених комами, без пробілів (використовуйте замість пробілів %% 20).
--profiling Увімкнути профілювання у наладчику скриптів.
--remote-debug <address> Віддалене налагодження (<host/IP>:<port> адреса).
--debug-collisions Показати форми зіткнення під час запуску сцени.
--debug-navigation Показати навігаційні полігони під час запуску сцени.
--frame-delay <ms> Імітувати високе завантаження процесора (затримувати кожен кадр на <ms> мілісекунд).
--time-scale <scale> Прискорити шкалу часу (більші значення швидші, 1,0 - нормальна швидкість).
--disable-render-loop Вимкнути цикл візуалізації (рендеру), візуалізація відбувається лише коли викликається із скрипту.
--disable-crash-handler Вимкнути обробник збоїв, якщо це підтримується кодом платформи.
--fixed-fps <fps> Форсувати фіксовану кількість кадрів в секунду. Цей параметр вимикає синхронізацію в режимі реального часу.
--print-fps Вивести кадри за секунду на екран.

Автономні інструменти

Команда Опис
-s <script>, --script <script> Запуск скрипту.
--check-only Розібрати лише помилки та закрите (використовуйте --script).
--export <target> Експортує проект використовуючи задану ціль експорту. Експортує лише основний пакет, якщо шлях закінчується .pck, або .zip (інструменти повинні бути включені).
--export-debug <target> Як --export, але використовує шаблон налагодження ( :ref: інструменти <doc_introduction_to_the_buildsystem_tools> повинні бути включені).
--doctool <path> Dump the engine API reference to the given <path> in XML format, merging if existing files are found (tools must be enabled).
--no-docbase Забороняє скидання базових типів (використовується з --doctool, інструменти повинні бути включені).
--build-solutions Будує скрипт рішень (наприклад, для проектів C#, ref:інструменти <doc_introduction_to_the_buildsystem_tools> повинні бути включені).
--gdnative-generate-json-api Generate JSON dump of the Godot API for GDNative bindings (tools must be enabled).
--test <test> Виконує тест одиниці. Спершу використовуйте --help для відображення списку тестів. ( інструменти повинні бути включені).

Шлях

Рекомендується, щоб ваш бінарний код Godot був у вашій змінній PATH, щоб його можна було легко виконати з будь-якого місця, набравши текст godot. Ви можете зробити так в Linux, помістивши в бінарний файл Godot /usr/local/bin і переконавшись, що він викликається з допомогою godot.

Налаштування шляху проекта

Залежно від того, де розміщений ваш бінарний файл 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 --path path_to_your_project --export my_export_preset_name game.exe

Як створити проект

Створення проекту з командного рядка можна здійснити, перемістивши оболонку до потрібного місця та створивши файл project.godot.

mkdir newgame
cd newgame
touch project.godot

Тепер проект можна відкрити в Godot.

Запуск редактора

Запуск редактора виконується шляхом введення команди Godot з позначкою -e. Це потрібно робити з каталогу проекту, або підкаталогу, інакше команда ігнорується і з'являється менеджер проектів.

godot -e

Якщо сцена була створена та збережена, її можна буде відредагувати пізніше, запустивши той самий код із цією сценою в якості аргумента.

godot -e scene.tscn

Видаляння сцени

Godot дружить з вашою файловою системою і не створюватиме зайві файли метаданих. Використовуйте rm для видалення файлу сцени. Переконайтеся, що ніщо не посилається на цю сцену, інакше виникне помилка.

rm scene.tscn

Запуск гри

Щоб запустити гру, просто введіть Godot в каталозі, або підкаталозі, проекту.

godot

Коли певну сцену потрібно протестувати, передайте її в командний рядок.

godot scene.tscn

Налагодження

Виловлювання помилок у командному рядку можуть бути складним завданням, оскільки вони просто проходять мимо. Для цього надається відладчик командного, викликається додаванням -d. Він працює для запуску, або гри, або простої сцени.

godot -d
godot -d scene.tscn

Експортування

Exporting the project from the command line is also supported. This is especially useful for continuous integration setups. The version of Godot that is headless (server build, no video) is ideal for this.

godot --export "Linux/X11" /var/builds/project
godot --export Android /var/builds/project.apk

Імена платформ, розпізнані комутатором, як --export, такі самі, як відображені в майстрі експорту редактора. Щоб отримати список підтримуваних платформ з командного рядка, спробуйте експорт на невпізнану платформу, і буде показано повний перелік платформ, які підтримують вашу конфігурацію.

Для експорту налагодженої версії гри використовуйте перемикач --export-debug замість --export. Їх параметри та використання однакові.

Запуск скрипта

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.

Ось простий приклад того, як це працює:

# sayhello.gd
extends SceneTree

func _init():
    print("Hello!")
    quit()

І як це запустити:

# 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).