Экспорт проектов

Зачем экспортировать?

Изначально, Godot не имел никаких способов экспорта проекта. Разработчики просто собирали исполняемые файлы и пакеты для каждой платформы вручную.

Когда все больше разработчиков (и даже непрограммистов) начали использовать его, и когда наша компания начала брать больше проектов одновременно, стало очевидно, что это узкое место.

На ПК

Распространить игровой проект на ПК с помощью Godot довольно просто. Поместите двоичный файл Godot в тот же каталог, что и файл project.godot, затем заархивируйте каталог проекта, и все готово.

Звучит просто, но, вероятно, есть несколько причин, по которым разработчик может этого не делать. Во-первых, нежелательно распространять множество файлов. Некоторым разработчикам может не понравиться, когда любопытные пользователи смотрят на то, как была сделана игра, другим она может показаться неэлегантной и так далее. Другая причина заключается в том, что разработчик может предпочесть специально скомпилированный двоичный файл, который меньше по размеру, более оптимизирован и не включает такие инструменты, как редактор и отладчик.

Наконец, Godot имеет простую но эффективную систему создания DLC как дополнительных пакетов файлов.

Предупреждение

Godot пока не поддерживает загрузку файлов PCK размером более 2 ГБ. Если ваши экспортированные данные проекта превышают 2 ГБ, вам нужно будет разделить их на несколько файлов PCK экспортировав дополнительные файлы PCK и загрузив их во время выполнения.

На мобильных платформах

Тот же сценарий на мобильных платформах немного хуже. Для распространения проекта на этих устройствах создается двоичный файл для каждой из этих платформ, который затем добавляется в собственный проект вместе с данными игры.

Это может быть проблематично, потому что это означает, что разработчик должен быть ознакомлен с SDK каждой платформы еще до того, как сможет экспортировать. В то время как изучение каждого SDK всегда поощряется, может быть неприятно быть вынужденным делать это в нежелательное время.

У этого подхода есть еще одна проблема: различные устройства предпочитают запускать некоторые данные в разных форматах. Главный пример - сжатие текстур. Всё оборудование ПК использует сжатие S3TC (BC), которое было стандартизировано более десяти лет, но мобильные устройства используют разные форматы сжатия текстур, такие как PVRTC (iOS) или ETC (Android).

Export menu (меню экспорта)

После многих попыток использования различных рабочих процессов экспорта, текущий оказался наиболее эффективным. На момент написания этой статьи еще не все платформы поддерживаются, но число поддерживаемых платформ продолжает расти.

Чтобы открыть меню экспорта, нажмите кнопку Export (экспорт):

../../../_images/export.png

Откроется меню экспорта. Однако оно будет совершенно пустым. Это потому, что нам нужно добавить предустановку экспорта.

../../../_images/export_dialog.png

Чтобы создать набор настроек экспорта, нажмите кнопку Add… (Добавить…) в верхней части меню экспорта. Откроется раскрывающийся список платформ для выбора предустановки экспорта.

../../../_images/export_preset.png

Для экспорта часто бывает достаточно параметров по умолчанию, поэтому их настройка обычно не требуется. Однако многие платформы требуют установки дополнительных инструментов (SDK) для возможности экспорта. Кроме того, для создания пакетов Godot необходимо установить шаблоны экспорта. Меню экспорта будет жаловаться, когда что-то отсутствует, и не позволит пользователю экспортировать для этой платформы, пока он не решит следующее:

../../../_images/export_error.png

Ожидается, что в это время пользователь вернётся к документации и последует инструкциям по правильной настройке этой платформы.

Экспорт шаблонов

Помимо настройки платформы, необходимо установить шаблоны экспорта, чтобы иметь возможность экспортировать проекты. Их можно получить в виде файла TPZ (который представляет собой переименованный ZIP-архив) на странице загрузки.

После загрузки их можно установить с помощью параметра Install Export Templates (Установить шаблоны экспорта) в редакторе:

../../../_images/exptemp.png

Export mode (режим экспорта)

При экспорте Godot составляет список всех файлов для экспорта, а затем создаёт пакет. Существует 3 различных режима экспорта:

  • Экспортировать все ресурсы проекта

  • Экспортировать выбранные сцены (включая зависимости)

  • Экспортировать выбранные ресурсы (включая зависимости)

../../../_images/expres.png

Export all resources in the project (Экспорт всех ресурсов в проекте) экспортирует все ресурсы в проекте. Export selected scenes (Экспорт выбранных сцен) и Export selected resources (Экспорт выбранных ресурсов) даёт вам список сцен или ресурсов в проекте, и вы должны выбрать каждую сцену или ресурс, которые хотите экспортировать.

../../../_images/expselected.png

Экспорт из командной строки

В производстве полезно автоматизировать сборки, и Godot поддерживает это с помощью параметров командной строки --export и --export-debug. Для экспорта из командной строки по-прежнему требуется предустановка экспорта для определения параметров экспорта. Базовый вызов команды:

godot --export "Windows Desktop" some_name

Это будет экспортировано в some_name.exe, если есть предустановка под названием "Windows Desktop" и шаблон, который можно найти. Путь вывода - относительно пути проекта или абсолютный; он не учитывает каталог, из которого была вызвана команда.

Вы также можете настроить его для экспорта только файла PCK или ZIP, что позволяет использовать один экспорт с несколькими исполняемыми файлами Godot. Это происходит, если имя цели заканчивается на .pck или .zip.

Часто бывает полезно комбинировать флаг --export с флагом --path, а также создавать специальный набор настроек экспорта для автоматического экспорта:

godot --path path/to/project --export "pck" game_name.pck

PCK по сравнению с форматами файлов ZIP Pack

У каждого формата есть свои плюсы и минусы. PCK - это стандартный и рекомендуемый формат для большинства случаев использования, но вы можете вместо этого использовать ZIP-архив, в зависимости от ваших потребностей.

Формат PCK:

  • Несжатый формат. Больший размер файла, но быстрее для чтения / записи.

  • Не читаются и не доступны для записи с использованием инструментов, которые обычно присутствуют в операционной системе пользователя, даже несмотря на то, что существуют сторонние инструменты для извлечения и создания файлов PCK.

Формат ZIP:

  • Сжатый формат. Меньший размер файла, но медленнее для чтения / записи.

  • Доступно для чтения и записи с помощью инструментов, обычно имеющихся в операционной системе пользователя. Это может быть полезно, чтобы упростить модификацию (см. также Экспортирование пакетов, патчей и модов).

Предупреждение

Из-за `известной ошибки <https://github.com/godotengine/godot/pull/42123> `__ при использовании файла ZIP в качестве файла пакета экспортированный двоичный файл не будет пытаться использовать его автоматически. Следовательно, вы должны создать сценарий запуска, на который игрок может дважды щелкнуть или запустить из терминала для запуска проекта:

:: launch.bat (Windows)
@echo off
my_project.exe --main-pack my_project.zip

# launch.sh (Linux)
./my_project.x86_64 --main-pack my_project.zip

Сохраните сценарий запуска и поместите его в ту же папку, что и экспортированный двоичный файл. В Linux обязательно предоставьте исполняемые права для сценария запуска с помощью команды chmod +x launch.sh.