Как интегрировать лаунчер с Epic Games Store

Как это работает

Вы можете интегрировать вашу игру с лаунчером в Epic Games Store. Это позволяет распространять другие ваши игры, опубликованные на Epic Games Store, через лаунчер.

Предварительные действия

Чтобы настроить интеграцию с Epic Games Store, вам потребуются:

• Epic App ID (Artifact ID);
• аккаунт с ролью администратора и приложение игры на портале разработчиков Epic Games;
• сборка игры для публикации в EGS;
• готовый лаунчер, настроенный в Личном кабинете;
• последняя версия BuildPatch Tool.

Получение Epic App ID (Artifact ID)

Чтобы найти Epic App ID:

1. Войдите на портал разработчиков Epic Games.
2. Перейдите к вашим продуктам (играм).
3. В карточке игры выберите вариант Epic Games Store.

4. В боковом меню нажмите Artifacts and Binaries и выберите sandbox-среду и артефакт.

5. Нажмите имя артефакта, чтобы увидеть Epic App ID.

Интеграция

Настройка авторизации

1. Если у вас не создана политика клиента, создайте ее:
   1. Войдите на портал разработчиков Epic Games.
   2. В настройках вашего продукта (игры) перейдите в раздел Product Settings > Clients > Add new client policy.
   3. В поле Client policy добавьте название политики.
   4. В раскрывающемся списке Client policy type выберите политику GameClient.
   5. Нажмите Add new policy.

2. Создайте клиент аутентификации:
   1. В настройках вашего продукта перейдите в раздел Product Settings > Clients > Add new client.
   2. Добавьте название клиента в поле Client name.В раскрывающемся списке Client policy выберите созданную политику.

3. Нажмите Create Application.

4. Назначьте созданный клиент:
   1. Нажмите Linked Clients в правом верхнем углу.
   2. Выберите ранее созданный клиент из раскрывающегося списка Select Clients.

5. Убедитесь, что права настроены правильно. Перейдите в раздел Permissions и, если он помечен как Not configured, включите и отключите любой из параметров, затем сохраните изменения.

6. В вашем проекте в Личном кабинете перейдите в раздел Login.
7. Выберите вариант авторизации и перейдите в раздел Аутентификация > Платформы публикации > Epic Games. Заполните поля ID приложения и Секретный ключ приложения. Значения полей вы можете скопировать из аккаунта разработчика Epic Games (раздел Product Settings > Clients > Edit client).
8. Нажмите Сохранить изменения.

Настройка платформы EGS и загрузка файлов

1. В вашем проекте в Личном кабинете перейдите в раздел Launcher.
2. Найдите нужный лаунчер на дашборде и нажмите Редактировать.
3. Перейдите в раздел Настройки и нажмите Настроить справа от логотипа платформы Epic Games.

4. Введите Epic App ID вашей игры.
5. Для правильной работы привилегий пользователя укажите Audience Item ID. Выполните следующие шаги для получения идентификатора:
   1. В настройках вашего продукта перейдите в раздел Epic Games Store > Offers.
   2. Определите, какие предложения будут использоваться для проверки привилегий лаунчера.Если у пользователя имеется предложение, которое вы выбрали, лаунчер будет считать, что у пользователя есть игра.
   Нажмите Edit offer, чтобы найти Audience Item ID.

7. Нажмите Скачать хост лаунчера, чтобы скачать архив LauncherHost.zip для Windows или macOS.
8. Нажмите Скачать конфигурационные файлы, чтобы скачать конфигурационный файл hostArgs.json для Windows или macOS.

Генерация и скачивание установщика лаунчера

Подготовка сборки игры для EGS

1. Распакуйте архив LauncherHost.zip, который вы скачали на предыдущем шаге в любую директорию. Этот архив содержит директориюпапку GameBuild для подготовки лаунчера к загрузке в Epic Games.

• LauncherHost.exe — исполняемый файл для утилиты LauncherHost;
• Qt5Core.dll vcruntime140-140_1.dll,msvcp140-140_1.dll — служебные библиотеки для утилиты LauncherHost.exe;
• installer — директория для установочного файла лаунчера.

Файловая структура для MacOS:

• LauncherHost — исполняемый файл для утилиты LauncherHost;Frameworks — системная директория для библиотек утилиты LauncherHost;
• installer — директория для установочного файла лаунчера.

2. Создайте новую директорию в директории GameBuild.
3. Скопируйте и вставьте сборку вашей игры в созданную директорию.
4. Перейдите в раздел Game > Build > Executable files и укажите имена исполняемых файлов для Windows и macOS и относительные пути до них.

5. Скопируйте установщик лаунчера и файл hostArgs.json в директорию GameBuild. В итоге директория GameBuild должна иметь следующую структуру:
   • Для Windows:

\---GameBuild
    |   hostArgs.json
    |   LauncherHost.exe
    |   msvcp140.dll
    |   msvcp140_1.dll
    |   Qt5Core.dll
    |   vcruntime140.dll
    |   vcruntime140_1.dll
    |
    \---installer
            installer.exe

2. • Для macOS:

\---GameBuild
    |   hostArgs.json
    |   LauncherHost
    |
    +---Frameworks
    |   \---QtCore.framework
    |       \---Versions
    |           \---5
    |               |   QtCore
    |               |
    |               \---Resources
    |                       Info.plist
    |                       QtCore.prl
    |
    \---installer
            Launcher.pkg

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

1. Распакуйте BuildPatch Tool, скачанный ранее.
2. Создайте директорию для использования BuildPatch Tool в качестве кэша для сборок.
3. Перейдите в директорию BuildPatchTool_x.y.z/Engine/Binaries/Win64(может отличаться в зависимости от версии BuildPatch Tool и операционной системы).
4. Откройте терминал внутри этой директории и выполните следующую команду для загрузки двоичных файлов игры. Для получения более подробных инструкций вы можете обратиться к документации.

.\BuildPatchTool.exe
  -ClientId="<YourClientId>"
  -ClientSecret="<secret>"
  -mode=UploadBinary
  -OrganizationId="<YourOrg>"
  -ProductId="<YourProduct>"
  -ArtifactId="<YourArtifact>"
  -BuildRoot="<absolute-path-to-GameBuild-directory>"
  -CloudDir="<absolute-path-to-cache-directory>"
  -BuildVersion="1.0.2-launcher-win"
  -AppLaunch="LauncherHost.exe"
  -AppArgs=""

Параметры команды:

• ClientId и ClientSecret доступны в Epic Games Developer Portal в разделе Product Settings > BPT Credentials.

• OrganizationId доступен на вкладке General Settings в разделе Organization > Settings.

• ProductId доступен на вкладке EOS SDK Credentials в разделе Product Settings > SDK Download & Credentials.

• Чтобы узнать значения параметров ArtifactId и BuildVersion, воспользуйтесь инструкцией. Значение параметра BuildVersion также доступно в меню действий на карточке игры в лаунчере Epic Games.

• AppLaunch — путь к основному исполняемому файлу относительно BuildRoot в следующем формате: 
  • LauncherHost.exe — для Windows;LauncherHost — для MacOS.

• AppArgs — дополнительные аргументы запуска. Может быть пустой строкой.

Назначение платформы артефакту

1. Перейдите на страницу артефакта.
2. Справа найдите раздел Inactive binaries, перейдите в меню  действий (…) и выберите Assign platforms. Укажите соответствующие платформы.

Получение доступа разработчика к игре в EGS-лаунчере

1. Добавьте нового пользователя в группы:
   1. Перейдите в раздел Product Settings > Player Groups.
   2. Нажмите на кнопку действий (…) рядом с конкретной группой игроков и выберите Edit Group.
   3. Перейдите на вкладку Add accounts, выберите Epic Games в качестве провайдера идентификации и укажите ID аккаунта.

2. Сгенерируйте ключи доступа:
   1. Перейдите в раздел Epic Games Store > Access keys.
   2. Нажмите Generate keys в правом верхнем углу.

2. 3. Выберите sandbox-среду и предложение, для которого вы хотите создать ключи.

2. 4. Введите название ключей в поле Batch name.
   5. Выберите тип Testing.Укажите количество.

2. 5. После создания ключей скачайте их. Для этого нажмите на кнопку действий (…) и выберите Download.

5. Нажмите кнопку профиля в правом верхнем углу лаунчера EGS и выберите пункт Redeem Code.
6. Активируйте загруженный ключ. После успешной активации ключа для предложения пользователю предоставляется доступ к этому конкретному предложению.

Обновление сборок игры

Для обновления существующих сборок игры повторите шаги по подготовке игровых сборок, загрузке в EGS и присвоению артефакту.