Как установить Steamworks SDK

16.07.2018

Настройка SDK для загрузки SteamPipe for Windows

Загрузите и распакуйте последнюю версию Steamworks SDK на машине, на которой вы будете загружать свои сборки.

Инструменты SteamPipe можно найти в SDK в папке инструментов, которая содержит 2 соответствующих подкаталога.

В каталоге ContentBuilder вы найдете контент вашей игры и инструменты сборки SteamPipe. Этот каталог содержит следующие подкаталоги:

• builder - этот каталог первоначально содержит только steamcmd.exe, который является версией командной строки Steam.
• builder_linux - Линейная версия steamcmd.
• builder_osx - версия macOS для macOS.
• content - Этот каталог содержит все файлы игр, которые будут встроены в депо.
• output - Этот каталог будет местом для журналов сборки, кэша блоков и промежуточного вывода. ПРИМЕЧАНИЕ. Эта папка может быть удалена или опущена в любое время, но после ее удаления последующее время загрузки займет больше времени.
• scripts - В этом каталоге вы разместите все свои скрипты сборки для создания своих игровых складов.

Рекомендуется запускать steamcmd.exe непосредственно в корневой папке для вашей платформы. Это должно заполнить каталог вашего builder`a всеми файлами, необходимыми для создания хранилищ.

Каталог ContentServer содержит инструменты для запуска вашего собственного Локального сервера контента SteamPipe, если вы решите это сделать.

SteamCmd на macOS

Чтобы включить SteamCmd в macOS, вы должны выполнить следующие шаги:

1. С терминала перейдите к папке tools \ ContentBuilder \ builder_osx \ osx32.

2. Запустить chmod + x steamcmd.

3. Перейдите к родительской папке (tools \ ContentBuilder \ builder_osx).

4. Тип bash ./steamcmd.sh.

5. Затем SteamCmd запускается и обновляется до последней сборки, оставляя вас в приложении SteamCmd.

6. Нажмите exit и нажмите Return, чтобы выйти из приложения.

7. Далее документация соответствует обеим платформам.

Создание файлов конфигурации SteamPipe Build

Чтобы загрузить приложение с помощью SteamPipe, вы должны создать скрипт, описывающий вашу сборку и каждый дополнительный пакет, который будет включен в нее. В папке ContentBuilder \ scripts для приложения с одним файлом есть простые примеры сценариев.

ВНИМАНИЕ. Вы можете назвать эти скрипты как угодно, но имена app_build_ AppID и depot_build_ AppID запрещены. Если вы знаете, что будете создавать приложения на этом компьютере, может быть хорошей идеей создать подкаталоги в вашем каталоге сценариев для каждого приложения, чтобы помочь организовать скрипты сборки каждого приложения.

Инструмент GUI SteamPipe

Если вы работаете в Windows и предпочтете, чтобы инструмент графического интерфейса помогал создавать эти файлы конфигурации и загружал ваши сборки, вы можете использовать SteamPipeGUI, который доступен в папке инструментов Steamworks SDK

Скрипт сборки файлов

Сначала создайте скрипт сборки для каждого пакета, который вы хотите загрузить. Начните с дублирования скрипта depot_build_1001.vdf и переименуйте его с идентификатором пакета, который будет загружаться.

Пример скрипта построения пакета:

Скрипт создания приложений

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

Следующие типы сборок, поддерживаемые SteamPipe:

• Preview - этот тип сборки выводит только журналы и манифест файла. Сборка предварительного просмотра здания - хороший способ повторить ваши скрипты загрузки.
• Local - создает для Локальный сервер контент SteamPipe. LCS строит загрузку на свой собственный LCS и позволяет протестировать установку вашей игры с помощью клиента Steam.
• SteamPipe - SteamPipe строит результат в ваших складах, фактически загружаемых в Steam.

Пример сценария создания приложения:

Построение пакета:

Чтобы запустить сборку, отредактируйте файл run_build.bat, чтобы включить учетную запись и пароли сборки Steamworks и путь к скрипту создания приложения.

После запуска run_build.bat ваш вывод сборки должен находиться в каталоге, указанном в файле скрипта сборки. Если сборка предварительного просмотра создает ожидаемый манифест, запустите сборку снова с помощью «предварительного просмотра» «0» в скрипте создания приложения.

Во время сборки SteamPipe выполняются следующие шаги:

• Steamcmd.exe регистрируется в бэкэнде Steam, используя заданную учетную запись Steam.
• Начало сборки приложения зарегистрировано на сервере MDS (Master Depot Server), который гарантирует, что пользователь имеет соответствующие привилегии для изменения этого приложения.
• Для каждого депо, включенного в сборку приложения, создается список файлов на основе файлов в папке содержимого и правил фильтрации, определенных в файле конфигурации сборки депо.
• Каждый файл сканируется и делится на небольшие куски размером около 1 МБ. Если депо было построено ранее, это разбиение будет сохранять как можно больше неизменных кусков.
• Новые фрагменты файлов сжимаются, зашифровываются, а затем загружаются в MDS.
• Для этой версии депо создается последний манифест; каждый манифест идентифицируется уникальным 64-битным идентификатором манифеста.
• После того как все депо были обработаны, MDS завершает создание этого приложения и назначает ему глобальный идентификатор buildID.
• После того, как сборка завершена, в папке build up могут быть файлы * .csm и * .csd. Они являются временными и могут быть удалены, но они ускоряют последующие времена сборки.