XCOM 2: SDK Schnellstartanleitung

XCOM 2: SDK Schnellstartanleitung
Inhalt
Einführung..................................................................................................................................................... 1
Vor dem Start ................................................................................................................................................ 2
Das XCOM2-SDK in Steam installieren ...................................................................................................... 2
Installation des Visual Studio 2013 Shell (Isoliert) Redistributable Package ............................................ 2
Modbuddy für XCOM 2 starten ................................................................................................................ 3
Erstmalige Einrichtung .............................................................................................................................. 3
Startseite ................................................................................................................................................... 4
Neues Projekt ............................................................................................................................................ 5
Die Mod-Pipeline .......................................................................................................................................... 5
Mod-Komponenten .................................................................................................................................. 5
Erstellen .................................................................................................................................................... 6
Testen........................................................................................................................................................ 7
Veröffentlichen ......................................................................................................................................... 8
Veröffentlichung im Steam Workshop ..................................................................................................... 8
Eigenständige Veröffentlichung ................................................................................................................ 9
Einführung
Das XCOM2-SDK zur Erstellung von Mods besteht aus drei Hauptkomponenten:
1. Firaxis' Modbuddy mit XCOM 2-Erweiterungen
2. XCOM2 64-bit-Version von UnrealEd
a. Dieses Programm kann auch UE3-Commandlets wie den Script Compiler oder Cooker
ausführen
3. Inhalte der XCOM 2-Verkaufsversion
a. Nicht gecookte (kompilierte) Karten und Pakete
b. UnrealScript-Quellcode
Der Schwerpunkt dieser Schnellstartanleitung liegt auf der Installation und Einrichtung von Modbuddy.
Sie demonstriert außerdem, wie man damit einen Beispiel-Mod öffnet und veröffentlicht.
Vor dem Start
Um einen XCOM 2-Mod zu erstellen, musst du zuerst Modbuddy starten.
Das XCOM2-SDK in Steam installieren
Das XCOM2 SDK findest du in Steam unter Bibliothek->Tools.
Navigiere zu den Tools:
Finde das XCOM2-SDK unter dem Namen "XCOM 2 SDK" und wähle im Rechtsklickmenü die Option
'Spiel installieren...'.
Installation des Visual Studio 2013 Shell (Isoliert) Redistributable Package
Modbuddy für XCOM 2 setzt wie die bereits zuvor für Civilization veröffentlichten Modbuddy-Versionen
auf die isolierte Visual Studio Shell als Entwicklungsumgebung (IDE) zur Erstellung von Mods. Das
Redistributable Package wird innerhalb des Installationspfads des Spiels im Unterverzeichnis
"Binaries\Redist" installiert. Beispiel: "\SteamLibrary\steamapps\common\XCOM 2
SDK\Binaries\Redist".
Modbuddy für XCOM 2 starten
Wähle "Spiel starten... " aus dem Rechtsklickmenü des XCOM 2-SDK in Steam, um Modbuddy für XCOM
2 zu starten. Der erstmalige Start der Entwicklungsumgebung (IDE) kann eine Weile dauern.
Erstmalige Einrichtung
Nach dem ersten Start von Modbuddy sollten die Benutzer allgemeine IDE-Einstellungen bezüglich des
Installationspfads von XCOM 2 festlegen. Wähle hierfür Tools->Options und scrolle dann wie unten
gezeigt zum unteren Ende des Optionsmenüs. Stelle sicher, dass die Pfadangaben korrekt eingestellt
sind.
XCOM 2 Install Path (Installationsverzeichnis) – Dieser Pfad sollte auf die Installation des SPIELS
verweisen und mit 'XComGame' enden.
XCOM 2 User Path (Benutzerverzeichnis) – Dieser Pfad sollte auf die Installation des SDK verweisen und
mit 'XComGame' enden.
Standardmäßig ist die Ausführlichkeit der MSBuild-Projektbuild-Ausgabe in der isolierten Visual Studio
Shell auf "Minimal" eingestellt. Um Informationen vom Buildvorgang/Script-Compiler zu erhalten,
solltest du diese Einstellung ändern. Wähle hierzu Extras->Optionen->Projekte und Projektmappen-
>Erstellen und Ausführen. Ändere dann die Einstellungen der beiden Ausführlichkeits-Dropdown-Menüs
unten im Optionsfenster auf "Normal" und klicke auf OK.
Startseite
Beim ersten Start der IDE wird eine Startseite angezeigt, über die der
Benutzer neue Mod-Projekte erstellen, bestehende Mod-Projekte öffnen
und auf die Liste der zuletzt geöffneten Mod-Projekte zugreifen kann.
Im Rahmen dieser Schnellstartanleitung erstellen wir ein neues ModProjekt. Wähle hierzu "New Mod" (Neuer Mod).
Neues Projekt
Nach der Auswahl von "New Mod" (Neuer Mod) wird
der auf der rechten Seite gezeigte Dialog angezeigt.
Standardmäßig zeigt der Dialog XCOM 2Projektvorlagen, die zur Erstellung eines neuen
Projekts genutzt werden können.
Für unser Beispiel wählen wir die Vorlage
ExampleWeapon. Dieses Projekt ist ein Beispielprojekt
und enthält bereits sämtliche Script-Codes,
Konfigurationsdateien, Lokalisierungsdateien und
Inhaltspakete, die benötigt werden, um dem Spiel eine
neue Waffe hinzuzufügen.
Wähle 'ExampleWeapon' und dann OK.
Die Mod-Pipeline
Nachdem wir ein Mod-Projekt erstellt haben, können wir nun alle zum Mod gehörenden Komponenten
ansehen und den Mod auch exportieren, testen und veröffentlichen.
Mod-Komponenten
Mods für XCOM 2 bestehen aus vielen verschiedenen Datentypen, die zusammen das XCOM 2Grundspiel verändern.
Script Code: Script Code ist die mächtigste Form von Mod-Inhalten. In unserem Beispiel-Mod definiert
der Script Code ein Data Template (Datenvorlage), welches
die Spieldaten zur Beschreibung der Funktion der neuen
Waffe enthält. Wieviel Schaden richtet sie an? Welche
Verbesserungen kann sie benutzen? Welche Technikstufe benötigt sie? Muss sie gefertigt werden oder
steht sie von Beginn an zur Verfügung? Wieviel wird sie kosten? Datenvorlagen kratzen lediglich an der
Oberfläche dessen, was mithilfe von Script Codes hinzugefügt werden kann. Script Codes können das
XCOM-Spielerlebnis radikal verändern, wenn sie mit dem Spiel ausgelieferte Script Codes überschreiben.
Unreal Content Packages (Inhaltspakete): Unreal-Inhaltspakete können UPK- oder MAP-Dateien sein.
Diese Dateien enthalten die Inhalte des Spiels:
Gittermodelle, Texturen, Animationen, Sounds, physikalische
Modelle, Archetypen usw. Unser Beispiel-Waffen-Mod enthält ein einzelnes Paket mit dem Namen
WP_ModExampleWeapon_CV, das definiert, wie unsere Waffe aussieht, klingt oder feuert, welche
Projektile sie benutzt, wie sie zu Boden fällt, wenn sie fallengelassen wird, usw. Dieses Paket wird vom
obigen Data Template verwendet. Inhaltspakete werden mit UnrealEd erstellt, doch darauf gehen wir
später ein.
Config Files (Konfigurationsdateien): Konfigurationsdateien oder INIs stellen dem Spiel Einstellungen
und Standardwerte zur Verfügung. Sie sind bequem zu
handhaben, da das Spiel nach ihrer Bearbeitung nicht neu
kompiliert werden muss und weil das UE3-interne System zur Verarbeitung von Konfigurationsdateien
das Überschreiben einzelner Einstellungen zulässt, während der Rest unverändert bleibt. Diese
praktische Eigenschaft kommt auch in unserem Beispiel-Waffen-Mod zum Tragen, bei der die
Konfigurationsdateien XComEditor und XComEngine, die beide über eine riesige Anzahl von
Einstellungen verfügen, unser Mod-Paket einfach zu den Listen hinzufügen, die der Engine mitteilen,
dass unsere gemoddetes Script-Paket existiert. Auf diese Art können viele Mods, die jeweils dieselben
Konfigurationsdateien verändern, problemlos nebeneinander koexistieren … zumindest die meisten.
Localization Files (Lokalisierungsdateien): Lokalisierungsdateien sind im Grunde nur verkappte
Konfigurationsdateien, die einem spezifischen Zweck
dienen: sie enthalten sämtliche im Spiel angezeigten Texte.
Unser Beispiel-Waffe-Mod verwendet englischsprachige (INT-)Strings für den 'friendly name' und andere
Felder, die zur fehlerfreien Anzeige der Waffe im Spiel benötigt werden.
Readme.txt & ModPreview.jpg: Das ModPreview-Bild wird zur Darstellung des Mod im Steam
Workshop verwendet, während die Datei readme.txt Anweisungen oder andere zum Mod gehörende
Informationen beinhalten kann.
Erstellen
Sobald der Mod-Inhalt erstellt wurde und zum Testen bereit ist, muss
der Mod in eine Form gebracht werden, die vom Spiel geladen werden
kann. Benutze hierfür die Option Build->Build Solution (Projektmappe
erstellen) in der Werkzeugleiste.
Ausgabefenster: Nach dem Klick
auf 'Build Solution'
(Projektmappe erstellen) zeigt die
IDE den Fortschritt des
Buildvorgangs im Ausgabefenster
der Anwendung an. Im Laufe des
Buildvorgangs erstellt Modbuddy
alle Dateien, die zum Testen und
Hochladen des Mod erforderlich
sind. Das Kompilieren des Script
Codes ist Teil dieses Vorgangs. Überprüfe die Ergebnisse der Script-Kompilierung auf Fehler- oder
Erfolgsmeldungen.
Testen
Es ist empfehlenswert, einen Mod während der Entwicklung lokal zu testen, bevor er im Steam
Workshop veröffentlicht wird. Das XCOM2-SDK bietet hierfür im DEBUG-Menü einen geeigneten
Mechanismus.
Klicke im Debug-Menü auf die Option 'Start Debugging' (Debuggen
starten), um den Testvorgang zu starten. Der Mod wird nun erstellt und
anschließend wird der XCOM 2-Launcher gestartet.
Wähle den Mod "ExampleWeapon" und klicke auf
'Spielen'. Der Launcher zeigt sämtlich Mods an, die vom
Benutzer abonniert oder installiert wurden. Bei lokalen
bzw. eigenständigen Mods wird im Beschreibungsfeld
der relative Pfad angezeigt. Nach dem Klick auf 'Spielen'
wird XCOM 2 mit dem aktivierten ExampleWeapon-Mod
gestartet.
Prüfe nun, ob der Mod ordnungsgemäß im Spiel funktioniert. Der ExampleWeapon-Mod fügt dem Spiel
eine neue Waffe hinzu, die von Beginn an zur Verfügung steht. Zum Testen starten wir eine
Einzelspieler-Kampagne und rüsten einen Soldaten mit der neuen Waffe aus.
Hier ist der Script Code aus dem Template mit den Eigenschaften, die die Waffe aufweisen soll:
Und der Mod, wie er sich in XCOM 2 darstellt:
Nachdem wir nun sichergestellt haben, dass der Mod wie vorgesehen funktioniert, sind wir bereit, ihn zu
veröffentlichen.
Veröffentlichen
Mods können im Steam Workshop veröffentlicht oder als eigenständige Pakete weitergegeben werden.
Veröffentlichung im Steam Workshop
Für eine Veröffentlichung im Steam Workshop musst du
zuerst die Steam Workshop-Seite besuchen und bestätigen,
dass dein Account dem Steam-Nutzungsvertrag zustimmt. Du
findest ihn unter Community->Workshop->Ihre Dateien->
Juristische Vereinbarung aufrufen.
Benutze anschließend die Option Tools->Publish Mod (Mod veröffentlichen) innerhalb der XCOM2-IDE.
Hierdurch wird der UGC-Upload-Prozess von Steam Workshop gestartet.
Informationen zum Erstellen und
Hochladen von Workshop-Objekten
werden im Ausgabefenster der IDE
angezeigt.
Besuche deine Workshop-Objekte-Seite
in Steam, um den veröffentlichten Mod
anzuzeigen.
Bitte beachte, dass die Sichtbarkeit eines
Mod beim erstmaligen Hochladen
standardmäßig auf 'versteckt' steht. Um
den Mod öffentlich verfügbar zu machen,
musst du die Sichtbarkeit des ModObjekts ändern.
Eigenständige Veröffentlichung
Die Veröffentlichung eigenständiger Mods umfasst das Packen der Mod-Inhalte für die Veröffentlichung
über eine Steam-fremde Quelle.
Um einen eigenständigen Mod zu veröffentlichen, musst du das Hauptverzeichnis
des XCOM2-SDK öffnen und den darin enthaltenen Unterordner
XComGame\Mods wählen. Du findest ihn üblicherweise innerhalb der
Verzeichnisstruktur einer Steam-Bibliothek oder der Steam-Installation – rechts
siehst du ein Beispiel.
Zippe/packe das Verzeichnis ExampleWeapon für die Veröffentlichung.
Um den Mod nun auf dem Computer eines anderen Benutzers zu installieren, muss der
ExampleWeapon-Ordner nur noch in dieselbe XComGame\Mods-Verzeichnisstruktur innerhalb seiner
XCOM 2-Installation kopiert werden.

Download Report