Startprogramm

Startprogramm ist ein personalisierbares Bereitstellungstool für Partner, die Videospiele entwickeln. Das Produkt optimiert Content-Bereitstellungskosten, indem Module für jegliche Sachen zentralisiert werden wie virtuelle Währung oder Videostreaming. Merkmale:

  • Verkauf von virtuellen Währungen und physischen Waren im Online-Shop
  • Integriertes Login mit anpassbarer Benutzeroberfläche und Authentifizierungsmethoden
  • Anpassbare Startprogramm-Benutzeroberfläche
  • Läuft unter Windows
  • Benutzeroberfläche in 20 Sprachen verfügbar
  • Automatische Auslieferung von Startprogramm-Updates an Benutzer
  • P2P/CDN-Spieleauslieferung und -Updates
  • Support mehrerer Spiele
  • Erwerb von Spielen über das Startprogramm samt automatischer Schlüsselaktivierung
  • Konfigurierbar über das Xsolla-Kundenportal
  • Verwaltung von Neuigkeiten und Bannern
  • Freunde aus sozialen Netzwerken
  • Ingame-Freundesliste
  • Benutzer können die Spielregion auswählen
  • Überbrückende Partner-Kanäle: nahtlose Integration von Spielen in bereits integrierte Spielplattformen

Note: Wenn Sie bereits eines der Xsolla-Module installiert haben und das Startprogramm integrieren möchten, wenden Sie sich bitte an Ihren Account Manager.

Integrationsablauf

  1. Im Xsolla-Kundenportal registrieren.
  2. Projekt erstellen.
  3. Startprogramm einrichten.
  4. Benutzeroberfläche des Startprogramms anpassen.
  5. Installationsdatei und Versionsarchiv des Startprogramms erstellen.
  6. Spielentwicklungsstufe (Build) auf den Xsolla-Update-Server hochlade.
  7. Installationsdatei des Startprogramms an neue Benutzer versenden.

Ein Projekt anlegen

  1. Gehen Sie zu Projekte und klicken Sie auf Neues Projekt anlegen.
  2. Im Setup-Modus:
    1. Geben Sie einen Projektname an.
    2. Legen Sie den Link zur Webseite fest.

Note: Jedes Projekt im Kundenportal ist gleichbedeutend mit einem Spiel.

Startprogramm einrichten

Erstellung einer Startprogramm-Instanz in Ihrem Kundenportal:

  1. Name des Startprogramms festlegen.
  2. Sprachen der Benutzeroberfläche festlegen.
  3. Vordefinierte Login-Konfigurationen auswählen oder durch Übermitteln des Namens eigene Konfiguration erstellen.
  4. Ein oder mehrere Projekte hinzufügen, die Sie im Kundenportal eingerichtet haben.

Nachdem Sie die Startprogramm-Einstellungen im Kundenportal vorgenommen, gehen Sie folgendermaßen vor:

  1. Klonen Sie das Startprogramm aus seinem GitHub-Repository.
  2. Öffnen Sie den Ordner, der das geklonte Repository enthält (Dateipfad: launcher/win) und legen Sie die Werte für die Objekte in der config.json-Datei fest.

Beispiel

{
   "launcher_project_id": "8c91ecf3-e7b0-46a8-aaf7-4c419ef8ef4b",
   "login_project_id": "bd2e1104-5494-48f9-ac50-98f230062df1",
   "callback_url": "https://callback_url.com",
   "product_name": "Launcher",
   "link_support": "https://support_example.com",
   "link_community": "https://community_example.com",
   "default_p2p_enabled": true,
   "game_autoupdate": false,
   "hide_peer_seed_info": false,
   "hide_email": false,
   "build_number": 1
}

Benutzeroberfläche des Startprogramms anpassen

Gehen Sie wie folgt vor, um Bilder, Schriftarten und das Startprogramm-Farbschema zu ändern:

  1. Öffnen Sie den Ordner mit den geklonten Repository (Dateipfad: launcher/win).
  2. Legen Sie die Werte für die Objekte in der UIStyle.json-Datei fest.

Beispiel

"error_window": {
  "bg_color": "#313131",
  "text_color": "white",
  "bottom_line_color": "white"
},
"error_report_window": {
  "bg_color": "#313131",
  "header_text_color": "white",
  "error_text_color": "white",
  "send_error_text_color": "#80FFFFFF",
  "bottom_line_color": "white"
},
"game_page": [
  {
    "game_id": 4,
    "bg_game_image": "img/Backgrounds/game_screen_bg.jpg",
    "version_text_color": "#7FFFFFFF",
    "social_text_color": "#7FFFFFFF"
  },
  {
    "game_id": 6,
    "bg_game_image": "img/Backgrounds/div_background.jpg",
    "version_text_color": "#7FFFFFFF",
    "social_text_color": "#7FFFFFFF"
  }
]

Nutzen Sie zur Anpassung des Online-Shops im Startprogramm die config.json-Datei.

Bilder ersetzen

Sie finden Bilder für das Startprogramm im Ordner img, gruppiert nach Startprogramm-Abschnitten: Background, LoginWindow usw. Um ein eigenes Bild hinzuzufügen, müssen Sie die entsprechende Datei ersetzen oder eine neue Datei im Ordner ablegen und den Link in UIStyle.json ändern.

Beispiel

Gehen Sie wie folgt vor, um my_custom_bg_image.jpg als Hintergrund des Login-Widgets zu verwenden:

  1. Legen Sie das Bild unter img/LoginWindow ab.
  2. Suchen Sie in UIStyle.json nach dem login_window-Objekt und ändern Sie
  3. “bg_image”: “img/LoginWindow/login_background.png” zu “bg_image”: “img/LoginWindow/my_custom_image.jpg”.

Note: Sie können das Startprogramm an 4K-Bildschirme anpassen, indem Sie Bilder in doppelter Größe mit einem “@2x”-Suffix hinter dem Dateinamen bzw. vor der Dateiendung versehen, z. B. login_background@2x.png.

Schriftarten ersetzen

Als Schriftarten für das Startprogramm kommen Lato Regular, Medium, Bold und Black zum Einsatz. Die Schriftarten befinden sich im Ordner fonts.

Gehen Sie folgendermaßen vor, um eine Schriftart zu ersetzen:

  1. Neue Schriftart im Ordner fonts ablegen.
  2. In UIStyle.json den Pfad zur neuen Schriftart folgendermaßen angeben:

"fonts": {
    "regular": "fonts/Lato-Regular.ttf",
    "medium": "fonts/Lato-Medium.ttf",
    "bold": "fonts/Lato-Bold.ttf",
    "black": "fonts/Lato-Black.ttf"
}

Beispiel

Gehen Sie folgendermaßen vor, um Lato-Black.ttf durch My_Own_Cool_Font.ttf zu ersetzen:

  1. My_Own_Cool_Font.ttf im Ordner fonts ablegen.
  2. In UIStyle.json den Pfad zu My_Own_Cool_Font.ttf folgendermaßen angeben:

"fonts": {
        "regular": "fonts/Lato-Regular.ttf",
        "medium": "fonts/Lato-Medium.ttf",
        "bold": "fonts/Lato-Bold.ttf",
        "black": "fonts/My_Own_Cool_Font.fft"
}

Farben ändern

Die Elementfarben der Startprogramm-Benutzeroberfläche sind in UIStyle.json nach Fenstern und Komponenten gruppiert. Um die Farbe eines Elements zu ändern, müssen Sie zum entsprechenden Abschnitt gehen und den Eigenschaftswert ändern.

Folgende Farbformate können verwendet werden:

  • SVG-Farben. Beispiel: “white”.
  • #RRGGBB. Beispiel: “#F13900”.
  • #AARRGGBB. Beispiel: “#40FFFFFF”.

Beispiel

Gehen Sie folgendermaßen vor, um Rot als Hintergrundfarbe des Einstellfensters auszuwählen:

  1. UIStyle.json öffnen und nach dem settings_screen-Objekt suchen.
  2. bg_color zu “bg_color”: “#FF0000” ändern.

Online-Shop anpassen

Um einen Ingame-Shop im Startprogramm anzupassen, fügen Sie ein Array von store-Objekten in die config.json-Datei ein. Sie können den Wert der in der Tabelle aufgeführten Objekte ändern:

Objekt Beschreibung
id Projekt-ID im Kundenportal.
theme Farbschema der Online-Shop. Entweder ‘default’ oder ‘dark’. ‘dark’ ist voreingestellt.
size Elementgröße im Online-Shop. Kann ‘small’, ‘medium’ oder ‘large’ sein. ‘large’ ist voreingestellt.
view Elementposition im Online-Shop (horizontales oder vertikales Menü). Kann ‘vertical_navigation’ oder ‘horizontal_navigation’ sein. ‘horizontal_navigation’ ist voreingestellt.

Beispiel

"store": { "id" : 12345, "theme" : "default", "size" : "large", "view" : "horizontal_navigation" } 

Standard-Symbol ändern

Um der Startprogramm auf einer bestimmten Spielseite zu öffnen, kann ein Benutzer eine Verknüpfung zum Start menü hinzufügen. Die Datei defaultIcon.ico wird standardmäßig als Verknüpfungssymbol verwendet und befindet sich im Ordner img/GamesIcon.

Sie können dieses Standardsymbol auf eine der folgenden Arten ändern:

  • Neues Bild in den Projekteinstellungen im Kundenportal hochladen.
  • Neue Datei in den Ordner img/GamesIcons hochladen. Das Dateiformat lautet {publisher_project_id}.ico, wobei {publisher_project_id} Ihre Projekt-ID im Kundenportal darstellt.

Beispiel: Bei 12345.ico handelt es sich um das Symbol für das Startprogramm, dem das Projekt mit der ID ‘12345’ hinzugefügt wurde.

Für eine vollständige Anpassung des Online-Shops im Xsolla-Startprogramm, senden Sie bitte Ihren UI-Baukasten oder Ihre Design-Elemente an Ihren Account Manager.

Archiv und Installationsprogramm erstellen

Das scripts/win/deploy.bat-Skript erstellt:

  • ein Installationsprogramm für das Startprogramm, welches an neue Nutzer versendet werden kann,
  • ein Build-Archiv für das Startprogramm zur automatischen Auslieferung von Updates an Benutzer.

Sie können die deploy.bat folgendermaßen ausführen:

  • durch Doppelklick auf die Skript-Datei – dadurch wird die Version/Entwicklungsstufe im geklonten Projektordner > Ziel-Unterordner abgelegt;
  • über die Eingabeaufforderung unter Verwendung eines zusätzlichen --out {directory} Schlüssels, wobei {directory} den gewünschten Installationspfad der Entwicklungsstufe darstellt.

Beispiel

deploy.bat --out C:/Target

Notice: Die Installationsdatei muss durch eine digitale Signatur verifiziert werden, die durch das SSH256-Zertifikat bestätigt ist. Sie können das Zertifikat bei einer der folgenden Zertifizierungsstellen anfordern: Thawte, Verisign/Symantec, Comodo und Digicert.
Note: Sie müssen das generierte Archiv samt Entwicklungsstufe des Startprogramms in Ihr Kundenportal hochladen.

Spiel-Entwicklungsstufe hochladen

Nutzen Sie die Eingabeaufforderung des Build-Loaders, um eine Entwicklungsstufe des Spiels auf den Update-Server hochzuladen.

Build-Loader Systemanforderungen:

  • Windows 7/8/10 64-Bit-Betriebssystem
  • 1,6 GHz CPU
  • 100 MB verfügbarer RAM
  • Freier Festplattenplatz: 1.5 × Buildgröße

Der Build-Loader akzeptiert folgende Befehle:

  • --init — initialisiert das Dienstprogramm
  • --update — übermittelt die Spiel-Entwicklungsstufe zum Server
  • --builds-list — ruft eine Liste der Spiel-Entwicklungsstufen ab
  • --descr {..} — übermittelt Beschreibung der Entwicklungsstufe
  • --api-key {..} — übermittelt API-Schlüssel
  • --game-path {..} — übermittelt den Pfad zur Spiel-Entwicklungsstufe

Gehen Sie folgendermaßen vor, um eine Spiel-Entwicklungsstufe (Build) hochzuladen:

  1. Im Kundenportal zu Build-Einstellungen gehen.
  2. API-Schlüssel kopieren.
  3. Build-Loader herunterladen und installieren.
  4. Dienstprogramm initialisieren.
  5. Spiel-Entwicklungsstufe(n) auf den Server hochladen.
  6. Entwicklungsstufe in das Stadium versetzen.
  7. Spieldateien einrichten.

Build-Loader initialisieren

Um das Dienstprogramm zu initialisieren, müssen Sie den zuvor kopierten API-Schlüssel und den Pfad zur Entwicklungsstufe des Spiels eingeben:

> xbuild_loader.exe --init --api-key {..} --game-path {..}

Note: Sie müssen das Dienstprogramm nur einmal initialisieren, es sei denn, Sie möchten besagte Parameter ändern.

Spiel-Entwicklungsstufe auf den Server hochladen

Um eine Entwicklungsstufe des Spiels auf den Server zu laden, müssen Sie den Pfad der Entwicklungsstufe angeben:

> xbuild_loader.exe --update --game-path {..}

Sie können diesen Parameter weglassen, wenn Sie ihn bereits beim Initialisieren des Dienstprogramms oder beim Hochladen der vorherigen Entwicklungsstufe verwendet haben.

Beim ersten Upload erhält der Update-Server die gesamte Entwicklungsstufe des Spiels. Danach erhält der Server die vom Build-Loader erstellten Patches.

Entwicklungsstufe (Build) in Stadium versetzen

Nach dem Upload auf den Server werden die Entwicklungsstufen im Kundenportal unter Projekt-Setup > Build-Einstellungen > Entwicklungsstufenliste angezeigt.

Wählen Sie eine der zwei Stadien aus, in das Sie die Entwicklungsstufe versetzen möchten:

  • master: Das Spiel ist für Endnutzer erhältlich,
  • test: Das Spiel ist lediglich für Testzwecke verfügbar.

Note: Zum Testen des Spiel, öffnen Sie das Startprogramm mit dem in der Konsole übermittelten Parameter --game_stage test. Zum Beispiel: launcher.exe --game_stage test.

Spieldateien einrichten

Damit das Startprogramm die korrekten Dateien an die Benutzer übermittelt, müssen zuerst die Installationsdateien eingerichtet und initialisiert werden.

  1. Gehen Sie im Kundenportal zu Build-Einstellungen und anschließend zu Spieldatei-Einstellungen.
  2. Geben Sie den Namen und die Endung der Datei ein, mit der das Spiel gestartet wird (z. B.: coolgame.exe).
  3. Legen Sie den Installationspfad des Spiels fest.
  4. Fügen Sie alle weiterverteilbaren Pakete hinzu, die zum Starten des Spiels erforderlich sind (z. B. Microsoft Visual C ++ 2017 Redistributable).

Das Startprogramm übermittelt dem Spiel folgende Parameter:

  • --xsolla-locale {locale}: Sprache der Benutzeroberfläche;
  • --xsolla-login-token {token}: Xsolla-Login-JWT (JSON Web Token);
  • --xsolla-playfab-token {token}: PlayFab-Token.

Startprogramm-Systemanforderungen

Empfohlene Konfiguration für den optimalen Betrieb des Startprogramms:

  • Windows 7/8/10 64-Bit-Betriebssystem
  • 1,6 GHz CPU
  • 300 MB verfügbarer RAM
  • Freier Festplattenspeicher: 180 MB
  • Aktuelle DirectX-Version

Anleitungen

Mit unseren Anleitungen können Sie einige der erweiterten Funktionen des Startprogramms ausprobieren:

FAQ

F. Weshalb sollte ich das Xsolla-Startprogramm nutzen, wenn ich doch meinen eigenes Startprogramm erstellen kann?

A. Um Ressourcen während der letzten Entwicklungsphase oder nach Fertigstellung des Spiels zu sparen, die Sie ansonsten für die Erstellung Ihres eigenen Startprogramms aufwenden müssten.

F. Was kostet mich das Xsolla-Startprogramm?

A. Bei dem Startprogramm handelt es sich um ein Mehrwertprodukt, d. h. der Zugriff auf das Startprogramm ist bereits im Xsolla-Grundpreis enthalten. Zusätzliche Kosten können entstehen, wenn Sie sich für die Verteilung von Spielen und Updates über das Xsolla-CDN entscheiden (0,01 $ pro GB). Durch die Nutzung des P2P-Ausgleichssystems können Sie die Kosten jedoch um durchschnittlich 80 % senken.

F. Muss das Startprogramm laufen, damit das Spiel funktioniert?

A. Das Startprogramm läuft standardmäßig immer. Beim Spielstart wird das Startprogramm minimiert und im Infobereich der Taskleiste angezeigt, sodass keine Ressourcen aufgebraucht werden. Ein Spieler kann den Startprogramm-Prozess beenden ohne dass das Spiel beendet wird, da während der tatsächlichen Spiele-Session keine Verbindung besteht.

F. Wo liegen die Unterschiede zu Steam? Was sind die Gemeinsamkeiten?

A. Das Xsolla-Startprogramm fungiert als eine Brücke zwischen Steam und einem Spiel.

F. Wird alles vom Startprogramm heruntergeladen, wenn das Spiel auf Steam zur Verfügung gestellt wird? Oder besteht der Upload auf Steam aus dem kompletten Spiel + Startprogramm und zusätzlichen Updates, die vom Startprogramm bereitgestellt werden?

A. Das Startprogramm kann jede der oben genannten Funktionen ausführen. Sie können die neueste Version Ihres Spiels in das Startprogramm integrieren und es anschließend auf Steam vertreiben, so dass keine zusätzlichen Downloads erforderlich sind (Gebühren werden auf Steam ausgewiesen). Wenn Sie ein Update zügig bereitstellen möchten, können Sie das Startprogramm zur schnellen Verteilung nutzen, ohne das Spiel in das Startprogramm integrieren oder bei Steam hochladen zu müssen. Sie haben also die Wahl.

F. Braucht der Entwickler zwei verschiedene Builds für Steam und die Stand-alone-Version? Oder wird derselbe Build auf Steam hochgeladen?

A. Nein, Sie brauchen keine zwei separaten Builds. Wenn Sie das Spiel sowohl auf Steam als auch als Stand-alone-Version bereitstellen, wird Ihnen das Startprogramm dabei helfen, die Nutzerdaten von beiden Plattformen in einer Datenbank zusammenzufassen. Es gibt ein Feature, das wir “nahtlose Registrierung” nennen. Dieses erlaubt es neuen Nutzern, die das Spiel zum ersten Mal in Steam ausführen, den Registrierungsprozess zu überspringen, da keinerlei Informationen abgefragt werden. Gleichzeitig können die Nutzer aber auf Ihre offizielle Website außerhalb des Steam-Universums gehen, sich mittels Steam OpenID anmelden und somit Teil einer offiziellen/zentralen Community werden (d. h. In Foren kommunizieren, neue Spiele entdecken, News lesen etc.).

F. Ich nutze von Steam bereitgestellte Werkzeuge, darunter deren Startprogramm und habe keine CDN-Kosten zu befürchten. Warum sollte ich dieses Risiko eingehen?

A. Sie können das Xsolla-Startprogramm nutzen, während Steam für CDN-Dienste bezahlt. Zudem können Sie Ihr Spiel, integriert in das Startprogramm, über Steam ausliefern. Es gibt kein Risiko, sondern zahlreiche Vorteile, denn über das Startprogramm können Sie mit Ihrer aktiven Community so kommunizieren, wie Sie es wünschen, da sich das Startprogramm komplett anpassen lässt. Außerdem können Sie Nutzerdaten erheben, damit Sie Ihre Fans außerhalb des Steam-Universums erreichen und mit ihnen kommunizieren können.

F. Habt ihr eine Liste der CDNs, die in eurem Startprogramm bereits integriert sind? Muss ich die CDNs kontaktieren? Kann ich ein CDN nutzen, welches nicht auf eurer Liste steht?

A. Ja, Xsolla verfügt über eine Liste der bereits integrierten CDN: G-Core Labs, Akamai. Unternehmen, deren CDN im Xsolla-Startprogramm bereits integriert sind, müssen nicht kontaktiert werden. Wenn Sie ein anderes CDN verwenden möchten, wenden Sie sich bitte an Ihren Account Manager.

F. Warum sollte ich nicht einfach Solid State Networks zurückgreifen?

A. Das Hauptgeschäft von Solid State Networks besteht aus CDNs, daher ist deren Startprogramm-Lösung nicht darauf ausgelegt, die CDN-Kosten zu optimieren.

F. Gibt es eine IPC-Lösung im Startprogramm?

A. Zurzeit gibt es keine IPC-Lösung, da das Startprogramm nicht über die Features verfügt, die zur IPC-Kommunikation benötigt werden. In Zukunft werden wir weitere Features hinzufügen wie Live-Streaming und einen Online-Shop im Overlay, der IPC (via SDK) erfordern wird. Wir haben also Pläne für neue Features.

F. Wie erhalten Benutzer des Xsolla-Startprogramms Zugriff auf Spiele? Können Spiele über Abonnements, Gutscheine oder Promocodes vertrieben werden?

A. Im Moment können Benutzer nur auf Spiele zugreifen, indem sie Spielschlüssel einlösen.

F. Können Benutzer des Xsolla-Startprogramms Spiele-Updates herunterladen, wenn sie keine Spielschlüssel erworben haben?

A. Nein. Spiele und Updates sind ohne den vorherigen Erwerb von Spielschlüsseln nicht verfügbar.

F. Gibt es eine Lösung, PCs im gleichen LAN über eine P2P-Verbindung zu vernetzen, damit die Daten nur innerhalb des LAN übertragen werden?

A. Nein, im Moment gibt es dafür keine Lösung.

F. Unterstützt das Xsolla-Startprogramm Zugriffsebenen? Zum Beispiel “alpha” für Testzwecke und “beta” für Endnutzer.

A. Ja, das Xsolla-Startprogramm unterstützt Zugriffsebenen. Beim Upload der Entwicklungsstufe (Build) Ihres Spiels können Sie zwei Stadien auswählen: test zum Testen oder master für Endbenutzer. Zum Aufrufen des Startprogramms mit Spielen, deren Veröffentlichung im Stadium=test erfolgt, übermitteln Sie den --game_stage test-Parameter in der Konsole. Zum Beispiel: launcher.exe --game_stage test.

F. Welche Spiele werden in der Spielliste des Xsolla-Startprogramms angezeigt? Alle Spiele oder nur jene, die von einem Benutzer erworben wurden?

A. Die Liste enthält alle Spiele, die zum Startprogramm hinzugefügt wurden. Die von einem Benutzer erworbenen Spiele verfügen über eine Spielen- und die restlichen über eine Kaufen-Schaltfläche.

F. Können bestimmte Benutzer kostenlose Spielschlüssel erhalten? Wie können diese Schlüssel eingesetzt werden?

A. Ja, Sie können die Spielschlüssel aus dem Kundenportal herunterladen und Ihren Benutzern kostenlos und auf jede erdenkliche Weise zusenden. Die Benutzer können ihre Schlüssel im Startprogramm aktivieren.

F. Können Benutzer in Spielen automatisch authentifiziert werden, nachdem sie im Startprogramm authentifiziert wurden?

A. Ja, für die automatische Ingame-Authentifizierung gibt es eine Lösung. Der --xsolla-login-token-Parameter wird genutzt, um Benutzerdaten aus dem Xsolla-Startprogramm an das Spiel zu übermitteln. Um Benutzerdaten abzurufen, dekodieren Sie den Parameterwert (siehe Anleitung).

F. Kann ich den Download-Link des Startprogramms an Benutzer senden, z. B. in der Anleitung zur Spielschlüssel-Aktivierung?

A. Der Download-Link für das Startprogramm ist nicht in der Anleitung zur Spielschlüssel-Aktivierung enthalten. Gehen Sie wie folgt vor, um den Link zu versenden:

  1. Generieren Sie die Installationsdatei.
  2. Laden Sie die Installationsdatei als DRM-freies Distributionspaket in den Spielschlüssel-Einstellungen im Kundenportal hoch.
Nach Kauf des Spiels erhält der Benutzer einen Download-Link für das Distributionspaket.