Mods: Installation, Ordner & Entwicklung Guide

Mods sind von Nutzern erstellte Pakete, die shapez 2 verändern oder erweitern — von einfachen Komfort‑Utilities bis hin zu neuen Maschinen, Gameplay‑Funktionen, Übersetzungen oder benutzerdefinierten Szenarien. Das Spiel unterstützt Mods nativ und verwendet eine definierte Ordnerstruktur, sodass Mods einfach installiert, entwickelt und geteilt werden können.

Wo Mods und persistente Daten hingehören

• Das Spiel speichert persistente Daten (einschließlich Mods, benutzerdefinierter Szenarien, Presets und exportierter Basisdaten) im Game Data Folder (auch bekannt als Game Data oder save/game Ordner).
• Pfade:
  • Windows: %USERPROFILE%\AppData\LocalLow\tobspr Games\shapez 2\
  • MacOS: ~/Library/Application Support/tobspr Games/shapez 2/
  • Linux: ~/.config/unity3d/tobspr Games\shapez 2/
• Öffne den Ordner aus dem Spiel heraus:
  • Hauptmenü → Play → Show Folder, dann zum übergeordneten Ordner wechseln.
  • Im Spiel → Blueprint Library → Open Folder, dann zum übergeordneten Ordner wechseln.
  • Debug Console Befehle: logs.open-folder oder savegames.open-folder (Hinweis: MacOS verwendet Player.log für einige Logs).

Aufbau des Mods‑Ordners und Installation

• Der mods‑Ordner innerhalb des Game Data Folder ist der Ort, an dem du Mods ablegst, damit das Spiel sie lokal lädt.
• Jeder Mod ist ein Unterordner innerhalb des mods‑Ordners. Das Spiel lädt jeden Unterordner als eigenen Mod.
• Steam Workshop Mods werden unterstützt und automatisch heruntergeladen, wenn du ihnen im Workshop folgst.

Modding‑Ressourcen und Werkzeuge

• Offizielle und Community‑Ressourcen:
  • Offizielle Modding‑Dokumentation und Richtlinien für Art/Assets, bereitgestellt vom Entwickler.
  • Beispiel‑Mods und das ShapezShifter (modding API) Repository sind auf GitHub verfügbar.
  • Inoffizielle Community‑Dokumentation ergänzt die offiziellen Docs.
  • Nützliche Drittanbieter‑Tooling‑Dokumentation: MonoMod RuntimeDetour und HarmonyX für Runtime‑Detouring und Patching.
• Das Spiel verwendet Unity (spezifische Unity‑Version in den Docs vermerkt) und eine Modding‑API (ShapezShifter), um die Integration zu vereinfachen; ein externer Mod‑Loader ist nicht erforderlich.
• Assembly‑ und Klassenreferenzen sind für tiefere Entwicklung und Debugging verfügbar.

Erstellen und Exportieren von Spieldaten für Mods

• Das Spiel kann seine internen Daten (Basisinhalt wie Entities, Szenarien, Presets) zum Wiederverwenden oder als Referenz exportieren:
  • Im Spiel die Debug Console (F1) öffnen und debug.export-game-data ausführen.
  • Dadurch wird ein Ordner namens basedata- im Game Data Folder erstellt. Verwende die dortigen Dateien als Vorlagen für eigene JSON‑Inhalte.

Benutzerdefinierte Szenarien, Presets und Schwierigkeitsgrade

• Benutzerdefinierte Szenarien:
  • Lege Szenario‑JSON‑Dateien in den custom-scenarios Ordner im Game Data Folder, damit das Spiel sie lädt.
  • Die im Spiel exportierten Szenario‑Dateien erscheinen im scenarios Ordner eines exportierten basedata‑Ordners.
• Benutzerdefinierte Szenario‑Presets:
  • Lege benutzerdefinierte Szenario‑Preset‑JSON‑Dateien in custom-scenario-parameter-presets im Game Data Folder.
  • Im Spiel lebende Szenario‑Presets befinden sich in scenario-parameter-presets in exportierten basedata‑Ordnern.
  • Beim Auswählen eines Scenarios wird das erste Scenario Preset in der internen Liste, das auf dieses Scenario verweist, als Standard ausgewählt.
• Benutzerdefinierte Schwierigkeits‑Presets:
  • Das Spiel unterstützt derzeit nicht das direkte Laden benutzerdefinierter Schwierigkeits‑Presets als JSON‑Dateien. Du kannst jedoch die im Spiel vorhandenen Schwierigkeits‑Presets im difficulty-presets Ordner eines exportierten basedata‑Ordners einsehen.

Benutzerdefinierte Übersetzungen

• Um benutzerdefinierte Übersetzungen zu laden, erstelle eine translations-override.json‑Datei mit dem gleichen Format wie translations-en-US.json und platziere sie an der erwarteten Stelle.
• Starte das Spiel mit dem Kommandozeilenargument --custom-translations, damit die Override‑Datei geladen wird.
• Der LanguageTitle innerhalb der Datei wird ignoriert; die Sprache erscheint in den Sprach‑Einstellungen als "Custom". Fehlende Keys fallen auf Englisch zurück.

Entwicklungs‑Workflow und Debugging

• Typischer Workflow:
  • Exportiere Basis‑Spieldaten, um bestehende JSONs als Vorlagen zu verwenden.
  • Erstelle einen Mod‑Unterordner mit deinen Assets, Code und JSON‑Definitionen entsprechend der Dokumentation und den Art‑Richtlinien.
  • Nutze die Modding‑API (ShapezShifter) oder Runtime‑Patching‑Bibliotheken, wenn du Code‑Verhalten ändern musst.
  • Teste lokal, indem du den Mod‑Ordner in das mods‑Verzeichnis legst und das Spiel startest.
• Die Debug Console ist im Spiel für Befehle und Fehlersuche verfügbar.
• Debugging‑ und Runtime‑Patching‑Dokumentation sowie Community‑Beispiele (Beispiel‑Mods) sind empfehlenswerte Referenzen.

Veröffentlichen und Teilen von Mods

• Steam Workshop:
  • Mods können im Steam Workshop veröffentlicht werden, um automatische Verteilung zu ermöglichen.
• Community‑Sharing:
  • Baupläne und Inhalte werden auch über die Community Vortex Webseite und den offiziellen Discord (#🛠blueprints) geteilt.
• Befolge die Richtlinien des Spiels zum Mod‑Publishing und zu Assets, wenn du veröffentlichst, um Konflikte oder defekte Assets zu vermeiden.

Themen & erweiterte Überlegungen

• Relevante Modding‑Themen, die in der Dokumentation behandelt werden:
  • Modding Overview, Development Environment, Mod Loading, Debugging, Mod Publishing, Command Line Arguments, Game Files, Custom Game Modes, Debug Console.
• Nutze bereitgestellte Beispiel‑Mods und API‑Referenzen, um Muster und Best Practices zu erlernen.
• Wenn du Inhalte als JSON änderst oder hinzufügst (Szenarien, Presets, Übersetzungen), stelle sicher, dass Dateinamen und Platzierung den erwarteten Ordnern entsprechen, damit das Spiel sie erkennt.

Kurze Checkliste zum Einstieg

• Basisdaten exportieren: Debug Console öffnen → debug.export-game-data.
• Erstelle einen Mod‑Ordner im Game Data Folder/mods/ und füge deinen Inhalt hinzu.
• Für benutzerdefinierte Szenarien oder Presets: JSONs in custom-scenarios bzw. custom-scenario-parameter-presets ablegen.
• Für Übersetzungen: translations-override.json erstellen und das Spiel mit --custom-translations starten.
• Im Steam Workshop abonnieren/hochladen, um Mods zu teilen oder zu erhalten.
• Konsultiere die offiziellen Modding‑Docs, Beispiel‑Mods und ShapezShifter für Code‑Beispiele und API‑Nutzung.