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

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

Примітка

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.

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

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

Команда

Опис

-h, --help, /?

Виводить список команд командного рядка.

--version

Виводить рядок версії.

-v, --verbose

Використовує детальний режим stdout.

--quiet

Тихий режим, приховує повідомлення stdout. Помилки все ще відображаються.

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

Команда

Опис

-e, --editor

Запускає редактор замість запуску сцени (інструменти повинні бути включені).

-p, --project-manager

Запускає керівник проєктів, навіть якщо проєкт виявлено автоматично (інструменти повинні бути включені).

-q, --quit

Вийти після першої ітерації.

-l <locale>, --language <locale>

Використати спеціальну локаль (<locale> - це двобуквенний код). Дивіться Локалі для більш докладної інформації.

--path <каталог>

Шлях до проєкту (<directory> повинен містити файл 'project.godot').

-u, --upwards

Сканування вищих папок на наявність файлу project.godot.

--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

Примусовий режим низького розширення (лише для macOS та Windows).

--no-window

Run with invisible window. Useful together with --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>

Експортує проtкт використовуючи задану ціль експорту. Експортує лише основний пакет, якщо шлях закінчується .pck, або .zip (інструменти повинні бути включені).

--export-debug <target>

Як --export, але використовує шаблон налагодження ( інструменти повинні бути включені).

--doctool <path>

Скинути посилання на API движка на вказаний <path> (шлях) у форматі XML, поглинання, якщо існуючі файли знайдені ((інструменти повинні бути ввімкненими).

--no-docbase

Забороняє скидання базових типів (використовується з --doctool, інструменти повинні бути включені).

--build-solutions

Будує скрипт рішень (наприклад, для проєктів C#, інструменти повинні бути включені).

--gdnative-generate-json-api

Створює дамп JSON Godot API для прив'язок GDNative ( інструменти повинні бути включені).

--test <test>

Виконує тест одиниці. Спершу використовуйте --help для відображення списку тестів. ( інструменти повинні бути включені).

--export-pack <preset> <path>

Як --export, але використовує шаблон налагодження ( інструменти повинні бути включені).

Шлях

Рекомендується, щоб ваш бінарний код 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

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

Також підтримується експорт проєкту з командного рядка. Це особливо корисно для безперервних інтеграційних налаштувань. Версія Godot, яка без заголовка (побудова сервера, без відео) ідеально підходить для цього.

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

Назва попередньо встановлених налаштувань має відповідати назві попередньо встановлених параметрів експорту, визначених у файлі проєкту export_presets.cfg. Якщо попередньо встановлена назва містить пробіли, чи спеціальні символи (наприклад, "Windows Desktop"), то вона повинна бути загорнута в лапки.

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

Щоб експортувати лише файл PCK, використовуйте параметр --export-pack після попередньо встановленого імені та вихідного шляху із розширенням файлу, замість --export. Розширення вихідного шляху визначає формат пакету, або PCK, або ZIP.

Попередження

При вказівці відносного шляху, як шляху для --export, --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).

Перший рядок 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