Лаунчер / Загрузка сборки игры
  На главную

Лаунчер

Загрузка сборки игры

Для загрузки сборки игры на сервер обновлений используется консольная утилита Build Loader.

Системные требования для Build Loader:

  • Операционная система: Windows 7/8/10 64-bit, macOS 10.14.0 и выше
  • Процессор (CPU): 1.6 ГГц
  • Свободный объем оперативной памяти (RAM): 100 МБ (или более)
  • Свободный объем жесткого диска: 150% от размера файла сборки игры

Build Loader принимает следующие параметры:

  • --init — инициализация утилиты.
  • --update — отправка сборки игры на сервер.
  • --builds-list — список сборок игры.
  • --descr <build-description> — описание сборки.
  • --api-key <API-key> — ключ API.
  • --game-path <path-to-game> — путь к сборке игры.
  • --chunk-size <chunk-size> — размер чанков — частей, на которые разбивается архив игры. Измеряется в МБ или ГБ. Параметр принимает значение от 10mb до 5120mb или от 1gb до 5gb, по умолчанию 5gb.
  • --retry-timeout <timeout> — интервал между попытками загрузки файлов, измеряется в секундах. Параметр принимает значение от 10 до 60, по умолчанию 20.
  • --retry-count <retry-count> — количество попыток загрузки файлов. Параметр принимает значение от 1 до 10, по умолчанию 3.
  • --set-build-on-test — размещение сборки игры на stage с названием test. Игра будет доступна только для тестирования.
  • --set-build-on-master — размещение сборки игры на stage с названием master. Игра будет доступна конечным пользователям. Этот параметр игнорируется, если указан параметр --set-build-on-test.

Чтобы загрузить сборку игры:

  1. Перейдите в раздел Настройки сборок в Личном кабинете.
  2. Скопируйте ключ API.
  3. Скачайте и установите Build Loader.
  4. Инициализируйте утилиту.
  5. Загрузите сборку игры на сервер.
  6. Разместите сборку игры на stage.
  7. Настройте файлы игры.

Скачивание и установка Build Loader

Чтобы скачать и установить Build Loader:

  1. В разделе Игры нажмите Настроить справа от названия игры.
  2. Перейдите в раздел Сборки > Сборки игр.
  3. Нажмите BuildLoader.zip, чтобы скачать для вашей операционной системы.
  4. Распакуйте архив.

Расположение утилиты относительно директории, в которую вы распаковали архив:

  • Для Windows: Win\build_loader.exe
  • Для MacOS: Mac/build_loader

Инициализация Build Loader

Чтобы инициализировать Build Loader:

  1. В разделе Игры нажмите Настроить справа от названия игры.
  2. Перейдите в раздел Сборки > Сборки игры.
  3. Нажмите значок + рядом с полем Ключ API (ID лаунчера). Этот ключ позволяет Build Loader загружать сборки на сервер.
  4. Инициализируйте утилиту с помощью следующей команды:

Загрузка на сервер

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

Если параметр --game-path уже использовался при инициализации или предыдущей загрузке сборки, его можно опустить. При первой загрузке сервер обновлений получает всю сборку игры, при следующих — патчи, сформированные Build Loader.
Примечание
Мы рекомендуем указывать параметр --descr, чтобы вы смогли различать загруженные сборки.
Чтобы найти сборки игр:
  1. Откройте ваш проект в Личном кабинете.
  2. Нажмите Лаунчер в боковом меню.
  3. Перейдите к разделу Игры.
  4. Нажмите Настроить справа от названия игры.
  5. Откройте раздел Сборки > Сборки игры.
  6. Перейдите к таблице Сборки игр.
Примечание
Если в сборке игры есть файлы, которые у конечных пользователей могут изменяться самой игрой, например файлы настроек, игрового профиля или сохранений, добавьте их в список игнорируемых файлов. Иначе, лаунчер обнаружит нарушение целостности файлов и скачает игру целиком.

Размещение на stage

Сборку игры можно разместить на stage следующими способами:
  • Во время загрузки сборки на сервер передайте Build Loader соответствующий параметр: --set-build-on-master или --set-build-on-test.
  • После загрузки сборки на сервер, сделайте следующее в проекте лаунчера:
    1. В разделе Игры нажмите Настроить справа от названия игры.
    2. Откройте раздел Сборки > Сборки игры.
    3. Перейдите к таблице Сборки игры.
    4. В таблице Сборки игры нажмите значок справа от нужной сборки.
    5. Нажмите Привязать к основной, чтобы привязать сборку игры к основной ветке. Или нажмите Привязать к тестовой — для тестовой. Если привязать к основной ветке, сборка игры будет добавлена в опубликованную сборку лаунчера. Если привязать к тестовой ветке, сборка игры будет добавлена в тестовую сборку лаунчера.
    6. Подтвердите выбор.
    7. Нажмите Закрыть.
    8. Вы увидите название ветки для сборки в столбце Ветка в таблице Сборки игры. Также сборка игры появится в таблице Ветки.
Примечание
Для тестирования игры запустите лаунчер с параметром -game_stage test в консоли. Пример: launcher.exe -game_stage test.

Настройка файлов игры

Для корректной загрузки игр из лаунчера необходимо настроить и инициализировать файлы загрузки:
  1. В разделе Игры нажмите Настроить справа от игры.
  2. Перейдите на вкладку Исполняемые файлы.
  3. Для каждой операционной системы укажите имя и расширение файла, запускающего игру. Этот файл должен находиться в корневой директории игры. Например: game.exe
  4. Если в игре есть распространяемые файлы:
    1. Перейдите на вкладку Редистрибутивы и нажмите Загрузить.
    2. В появившемся окне:
      1. Укажите название файла.
      2. Нажмите Загрузить файл и выберите исполняемый файл.
      3. Нажите Загрузить.
Лаунчер передает игре следующие параметры:
  • --xsolla-locale <locale>: язык интерфейса;
  • --xsolla-login-token <token>: Xsolla Login JWT (JSON Web Token).
ПРИМЕР

Туториалы

Прогресс интеграции
Спасибо за обратную связь!

Продолжить чтение

Следующие шаги

Генерация установочного файла
Последнее обновление: 10 октября 2023

Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.

Сообщите о проблеме
Мы постоянно улучшаем качество нашей документации. Ваш отзыв поможет нам в этом.
Укажите email-адрес, чтобы мы могли связаться с вами
Спасибо за обратную связь!