Como integrar o inicializador com a Epic Games Store

Como funciona

Você pode integrar seu jogo com o Launcher na Epic Games Store (GS). Ele permite que você promova seus outros jogos da EGS via Xsolla Launcher.

Pré-requisitos

Para configurar a integração da EGS, você precisará de:

• um Epic App ID (Artifact ID)
• uma conta com a função administrativa e aplicativo do jogo no Epic Games Developer Portal
• uma compilação de jogo na EGS
• um inicializador de uso pronto configurado na Conta de Distribuidor
• a última versão da BuildPatch Tool

Obtenha a Epic App ID (Artifact ID)

Para encontrar seu Epic App ID:

1. Acesse o Epic Games Developer Portal.
2. Acesse seus produtos de jogos.
3. No cartão de jogo, selecione a opção Epic Games Store.

4. No menu lateral, clique em Artefatos e Binários e escolha o sandbox e artefato.

5. Clique no nome do artefato para ver o Epic App ID

Etapas de integração

Configure a autorização

1. Se você não tem uma política de clientes, crie uma:
   1. Acesse o Epic Games Developer Portal.
   2. Nas configurações do seu projeto (jogo), acesse a seção Product Settings > Clients > Add new client policy.
   3. Adicione um nome de política no campo Client policy.
   4. Selecione a política GameClient da lista suspensa Client policy type.
   5. Clique em Add new policy.

2. Crie um cliente de login:
   1. Nas configurações do seu produto, acesse a seção Product Settings > Clients > Add new client.
   2. Adicione um nome de cliente no campo Client name.
   3. Selecione a política de cliente recém-criada na lista suspensa Client policy.

3. Clique em Create Application.

4. Atribua o cliente criado:
   1. Clique em Clientes Vinculados no canto superior direito.
   2. Selecione o cliente criado anteriormente na lista suspensa Select Clients.

5. Certifique-se de que as permissões estão configuradas, clique na barra de navegação Permissions. Caso ela esteja marcada como Not configured, ative e desative qualquer uma das opções e salve as configurações.

6. Em seu projeto na Conta de Distribuidor, acesse a seção Login.
7. Selecione uma opção de login e acesse a seção Autenticação > Plataformas de distribuição > Epic Games.
8. Preencha os campos ID do Aplicativo e Chave secreta do aplicativo. Você pode copiar os valores dos campos do Epic Games Developer Portal (a seção Product Settings > Clients > Edit client).
9. Clique em Salvar alterações.

Configure a plataforma EGS e baixe os arquivos

1. No seu projeto na Conta de Distribuidor, acesse a seção Inicializador.
2. Encontre o inicializador no painel e clique em Editar inicializador.
3. Acesse a seção Configurações e clique em Configurar à direita do logotipo da plataforma Epic Games.

4. Insira o Epic App ID do seu jogo.
5. Para garantir que o direito do usuário funcione corretamente, especifique o Audience Item ID. Siga os seguintes passos para recuperar o ID:
   1. Nas configurações do seu produto, acesse a seção Epic Games Store > Ofertas.
   2. Determine quais ofertas serão usadas para os inicializadores conferirem o direito. Se o usuário tiver uma oferta de direito que você escolheu, o inicializador vai considerar que o usuário possui o jogo.
   Clique em Edit offer para ver Audience Item ID.

7. Clique em Baixar host do inicializador para baixar o arquivo LauncherHost.zip para Windows ou macOS.
8. Clique em Baixar config para baixar o arquivo de configuração hostArgs.json para Windows ou macOS.

Gere e baixe o instalador do inicializador

Prepare a compilação do jogo para a EGS

1. Descompacte o arquivo LauncherHost.zip (que deve ter sido baixado no passo anterior) a qualquer pasta da sua escolha. Esse arquivo contém o diretório GameBuild, que será usado para preparar as compilações de jogo que serão enviadas ao Epic Dev Portal.

• LauncherHost.exe — um arquivo executável para o utilitário LauncherHost
• Qt5Core.dll vcruntime140-140_1.dll, msvcp140-140_1.dll — bibliotecas de serviço para o utilitário LauncherHost.exe
• installer — um diretório que contém o instalador do inicializador

Estrutura de pastas para MacOS:

• LauncherHost — um arquivo executável para o utilitário LauncherHost
• Frameworks — uma pasta do sistema para as bibliotecas do utilitárioLauncherHost
• installer — uma pasta que contém o instalador do inicializador

2. Crie uma nova pasta na pasta GameBuild.
3. Copie e cole a compilação do jogo nessa pasta.
4. Configure o nome do arquivo executável do jogo (Windows / macOS) na seção Jogo > Compilação > Arquivos executáveis e especifique o caminho relativo para o arquivo executável do jogo.

2. Copie o instalador do inicializador e o arquivo hostArgs.json ao diretório GameBuild. Como resultado, o diretório GameBuild deve ter a seguinte estrutura:
   • Para Windows:
   • Para MacOS:

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

2. • Para macOS:

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

Atualize as compilações de jogo à EGS

1. Descompacte a BuildPatch Tool baixada anteriormente.
2. Crie um diretório para a BuildPatch Tool utilizar como diretório de cache para as compilações de jogos.
3. Acesse o diretório descompactado BuildPatchTool_x.y.z/Engine/Binaries/Win64 (esse diretório pode variar de acordo com a versão BuildPatch Tool e o sistema operacional).
4. Abra um terminal dentro do diretório e execute o seguinte comando para enviar os binários do jogo. Você pode consultar a documentação para obter instruções mais detalhadas.

.\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=""

Os parâmetros de comando:

• ClientId e ClientSecret estão disponíveis no Epic Dev Portal na seção Product Settings > BPT Credentials.

• OrganizationId está disponível na seção General Settings na aba Organization > Settings.

• ProductId está disponível na seção EOS SDK Credentials na aba Product Settings > SDK Download & Credentials.

• Para encontrar os valores dos parâmetros ArtifactId e BuildVersion, consulte as instruções. O valor do parâmetro BuildVersion também está disponível no menu de ação no cartão de jogo no inicializador da Epic Games.

• AppLaunch — o trajeto ao arquivo executável principal relativo ao BuildRoot no seguinte formato:
  • LauncherHost.exe — para Windows LauncherHost — para MacOS

• AppArgs — argumentos de inicialização adicionais. Pode ser uma string vazia.

Atribuir plataformas ao artefato

1. Acesse a página dos artefatos.
2. No lado direito, navegue para a seção Inactive binaries, clique no botão do menu de ações (…), clique em Assign platforms. Selecione as plataformas de acordo.

Obtenha acesso de desenvolvedor ao jogo no inicializador da EGS

1. Adicione um novo usuário aos grupos:
   1. Acesse a seção Product Settings > Player Groups.
   2. Clique no botão do menu de ações (…) em um grupo de jogador particular e clique em Edit Group.
   3. Acesse a aba Add accounts, escolha Epic Games como um Provedor de Identidade e especifique o account ID.

2. Gere chave de acesso:
   1. Acesse a seção Epic Games Store > Access keys das configurações do seu projeto.
   2. Clique em Generate keys no canto superior direito.

2. 3. Selecione o sandbox e a oferta para a qual você deseja gerar as chaves.

2. 4. Insira o nome das chaves no campo Batch name.
   5. Selecione o tipo Testing.
   6. Especifique a quantidade.

2. 5. Quando as chaves forem criadas, baixe elas. Clique no botão do menu de ações (…) e clique em Download.

5. Clique no botão do perfil no canto superior direito do inicializador EGS e clique na opção Redeem Code.
6. Resgate a chave baixada. Quando uma chave para uma oferta for resgatada com sucesso, o usuário tem o direito àquela oferta em particular.

Atualize as compilações de jogo

Para atualizar as compilações de jogo existentes, repita as etapas para preparar as compilações de jogo, enviar à EGS, e atribuir ao artefato.