So integrieren Sie Launcher in den Epic Games Store

So funktioniert's

Sie können Ihr Spiel samt Launcher im Epic Games Store (EGS) integrieren und so Ihre anderen EGS-Spiele über Xsolla Launcher bewerben.

Voraussetzungen

Für die EGS-Integration benötigen Sie:

• eine Epic-App-ID (Artifact ID)
• ein Konto mit der Rolle “Administrator” und der Spielanwendung auf dem Epic Games Developer Portal
• eine Spiel-Build zur Veröffentlichung auf EGS
• einen im Kundenportal konfigurierten, einsatzbereiten Launcher
• die neueste Version des BuildPatch Tools

Epic-App-ID (Artifact ID) besorgen

So finden Sie die Epic-App-ID:

1. Melden Sie sich beim Epic Games Developer Portal an.
2. Wechseln Sie zu Ihren Spielprodukten.
3. Wählen Sie auf der Spielkarte die Option Epic Games Store.

4. Klicken Sie in der Seitenleiste auf Artifacts and Binaries, und wählen Sie die Sandbox und das Artefakt aus.

5. Klicken Sie auf den Namen des Artefakts, um die Epic-App-ID anzuzeigen.

Integrationsschritte

Autorisierung einrichten

1. Sofern Sie noch keine Kundenrichtlinie (Client Policy) haben, erstellen Sie eine:
   1. Melden Sie sich beim Epic Games Developer Portal an.
   2. Navigieren Sie in den Produkt-/Spieleinstellungen zu Product Settings > Clients > Add new client policy.
   3. Geben Sie einen Richtliniennamen in das Feld Client policy ein.
   4. Wählen Sie aus der Drop-down-Liste Client policy type die Richtlinie GameClient.
   5. Klicken Sie auf Add new policy.

2. Erstellen Sie einen Login-Client:
   1. Navigieren Sie in den Produkteinstellungen zu Product Settings > Clients > Add new client.
   2. Geben Sie im Feld Client name einen Client-Namen ein.
   3. Wählen Sie die zuvor erstellte Kundenrichtlinie aus der Drop-down-Liste Client policy aus.

3. Klicken Sie auf Create Application.

4. Weisen Sie den erstellten Client zu:
   1. Klicken Sie oben rechts auf Linked Clients.
   2. Wählen Sie den zuvor erstellten Client aus der Drop-down-Liste Select Clients aus.

5. Vergewissern Sie sich, dass die Berechtigungen konfiguriert sind, klicken Sie dazu in der Navigationsleiste auf Permissions. Falls der Menüpunkt mit Not configured gekennzeichnet ist, aktivieren und deaktivieren Sie eine der Optionen, und speichern Sie die Änderungen.

6. Navigieren Sie in Ihrem Projekt zum Menüpunkt Login.
7. Wählen Sie eine Anmeldemethode, und navigieren Sie zu Authentifizierung > Publishing-Plattformen > Epic Games.
8. Füllen Sie die beiden Felder Anwendungs-ID und Geheimer Schlüssel der Anwendung aus. Die entsprechenden Werte für die die beiden Felder können Sie aus dem Epic Games Developer Portal (unter Product Settings > Clients > Edit client) kopieren.
9. Klicken Sie auf Speichern.

EGS-Plattform einrichten und Dateien herunterladen

1. Navigieren Sie in Ihrem Kundenportal-Projekt zum Menüpunkt Launcher.
2. Wählen Sie den gewünschten Launcher aus, und klicken Sie auf Launcher bearbeiten.
3. Scrollen Sie zum Abschnitt Einstellungen, und klicken Sie rechts neben dem Epic-Games-Logo auf Einrichten.

4. Geben Sie die Epic-App-ID Ihres Spiels ein.
5. Damit die Nutzerberechtigung ordnungsgemäß funktioniert, müssen Sie die "Audience Item ID" angeben. So finden Sie die ID:
   1. Navigieren Sie in den Einstellungen Ihres Produkts zu Epic Games Store > Offers.
   2. Legen Sie fest, welche Angebote (Offers) für die Launcher verwendet werden sollen, um die Berechtigung zu überprüfen. Wenn der Nutzer über ein von Ihnen ausgewähltes Berechtigungsangebot verfügt, geht der Launcher davon aus, dass der Nutzer das Spiel besitzt.
   Klicken Sie auf Edit offer, daraufhin wird die Audience Item ID angezeigt.

7. Klicken Sie auf Launcher-Host herunterladen, um das Archiv LauncherHost.zip für Windows oder macOS herunterzuladen.
8. Klicken Sie auf Config herunterladen, um die Konfigurationsdatei hostArgs.json für Windows oder macOS herunterzuladen.

Startprogramm-Installer generieren und herunterladen

Spiel-Build für EGS vorbereiten

1. Entpacken Sie das (im vorherigen Schritt heruntergeladene) Archiv LauncherHost.zip in einem Ordner Ihrer Wahl. Dieses Archiv enthält ein Verzeichnis (GameBuild), mit dem die Spiel-Builds vorbereitet werden, die später in das Epic Dev Portal hochgeladen werden.

• LauncherHost.exe – ausführbare Datei für das Dienstprogramm LauncherHost
• Qt5Core.dll vcruntime140-140_1.dll, msvcp140-140_1.dll – Servicebibliotheken für das Dienstprogramm LauncherHost.exe
• installer – das Verzeichnis mit dem Launcher-Installer

Verzeichnisstruktur unter macOS:

• LauncherHost – ausführbare Datei für das Dienstprogramm LauncherHost
• Frameworks – Systemordner für die Bibliotheken des Dienstprogramms LauncherHost
• installer – Ordner mit dem Launcher-Installer

2. Erstellen Sie einen neuen Ordner im Verzeichnis GameBuild.
3. Kopieren Sie Ihre Spiel-Build in dieses Verzeichnis.
4. Konfigurieren Sie die ausführbare Spieldatei (Windows/macOS) unter Spiel > Build > Ausführbare Dateien, und geben Sie den relativen Pfad zur ausführbaren Spieldatei an.

5. Kopieren Sie den Launcher-Installer und die Datei hostArgs.json in das Verzeichnis GameBuild. Das Verzeichnis GameBuild müsste daraufhin die folgende Struktur aufweisen:
   • Unter Windows

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

2. • Unter macOS:

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

Spiel-Builds in den EGS hochladen

1. Entpacken Sie das zuvor heruntergeladene BuildPatch Tool.
2. Erstellen Sie ein Verzeichnis für das BuildPatch Tool, das als Cache-Verzeichnis für Spiel-Builds verwendet werden soll.
3. Wechseln Sie zum entpackten Verzeichnis BuildPatchTool_x.y.z/Engine/Binaries/Win64 (variiert je nach Version des BuildPatch-Tools und Betriebssystem).
4. Öffnen Sie in diesem Verzeichnis die Windows-Eingabeaufforderung bzw. (unter macOS) Terminal, und führen Sie den folgenden Befehl aus, um die Spiel-Binärdateien hochzuladen. Weitere Anweisungen finden Sie in der Dokumentation.

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

Die Befehlsparameter:

• ClientId und ClientSecret sind im Epic Dev Portal unter Product Settings > BPT Credentials verfügbar.

• OrganizationId ist unter General Settings auf der Registerkarte Organization > Settings verfügbar.

• ProductId ist unter EOS SDK Credentials auf der Registerkarten Product Settings > SDK Download & Credentials verfügbar.

• Die Werte der beiden Parameter ArtifactId und BuildVersion finden Sie in der Anleitung. Der Wert des Parameters BuildVersion ist auch im Aktionsmenü auf der Spielkarte im Epic Games Launcher verfügbar.

• AppLaunch – Pfad zur ausführbaren Hauptdatei relativ zu BuildRoot in dem folgenden Format:
  • LauncherHost.exe – unter Windows, LauncherHost – unter macOS

• AppArgs – zusätzliche Argumente für den Start. Ein leerer String ist hier möglich.

Dem Artefakt Plattformen zuweisen

1. Wechseln Sie zur Artefaktseite.
2. Scrollen Sie rechts zum Abschnitt Inactive binaries, klicken Sie auf die Aktionsmenü-Schaltfläche (…) und dann auf Assign platforms. Wählen Sie die entsprechenden Plattformen aus.

Entwicklerzugang zum Spiel im EGS Launcher erhalten

1. Fügen Sie den Gruppen einen neuen Nutzer hinzu:
   1. Navigieren Sie zu Product Settings > Player Groups.
   2. Klicken Sie bei der gewünschten Spielergruppe auf die Aktionsmenü-Schaltfläche (…) und dann auf Edit Group.
   3. Wechseln Sie zur Registerkarte Add accounts, wählen Sie Epic Games als "Identity Provider", und geben Sie die Account ID an.

2. Generieren Sie die Zugangsschlüssel:
   1. Navigieren Sie in Ihren Projekteinstellungen zu Epic Games Store > Access keys.
   2. Klicken Sie oben rechts auf Generate keys.

2. 3. Wählen Sie die Sandbox und das Angebot (Offer) aus, für das Sie die Schlüssel generieren möchten.

2. 4. Geben Sie im Feld Batch name den Namen für die Schlüssel ein.
   5. Wählen Sie Testing als Typ.
   6. Legen Sie die Menge fest.

2. 5. Laden Sie die Schlüssel herunter, sobald diese erstellt sind. Klicken Sie dazu auf die Aktionsmenü-Schaltfläche (…) und dann auf Download.

5. Klicken Sie oben rechts im EGS-Launcher auf die Profilschaltfläche und dann auf Redeem Code.
6. Lösen Sie den heruntergeladenen Schlüssel ein. Sobald ein Schlüssel für ein Angebot (Offer) erfolgreich eingelöst wurde, darf der Nutzer dieses spezielle Angebot in Anspruch nehmen.

Spiel-Builds aktualisieren

Wenn Sie die vorhandenen Spiel-Builds aktualisieren möchten, müssen Sie die einzelnen Schritte (Spiel-Builds vorbereiten, in den EGS hochladen und dem Artefakt zuweisen) wiederholen.