Captain of industry modding

Kapitän des Branchenmoddings

Willkommen in der offiziellen Modding -Ressource für den Kapitän des Branchenspiels.

Status der Modding -Unterstützung

COI ist derzeit auf Steam erhältlich und befindet sich in der frühen Zugangsstufe. Während Modding möglich ist, wird es noch nicht offiziell unterstützt. Wir arbeiten kontinuierlich an der Verbesserung der Modding -Unterstützung und -dokumentation.

Fragen, Probleme

Beachten Sie, dass Mod -Unterstützung experimentell ist und APIs möglicherweise brechen Änderungen haben. Wenn Sie Probleme haben, untersuchen Sie die Protokolle immer im %APPDATA%/Captain of Industry/Logs -Verzeichnisses, sie enthalten viele nützliche Informationen. Wenn Sie Modding-Themen mit der Community und den Entwicklungen besprechen möchten, besuchen Sie unseren Generalkanalkanal #Modding-dev-General (Sie müssen sich eine Mod creation in #pick-your-roles-here -Kanal zuweisen). Sie können hier auch Probleme unter GitHub einreichen, aber die Reaktionszeit unseres Teams könnte sich verzögern.

Voraussetzungen

Um Modding COI zu starten, müssen Sie:

1. Eigener Branchenkapitän bei Steam und lassen Sie das Spiel installieren.
2. .NET Framework 4.7.1 installieren.
3. (Optional) haben die Einheit 2022.3.5f1 (nur für die Erstellung von Vermögenswerten) installiert.

Erste Schritte

1. Suchen Sie die COI -Spieldateien über die rechte Klicken Sie mit der rechten Maustaste auf den Spieltitel im Steam -Client -> Properties... -> Local Files -> Browse .
2. Kopieren Sie den Spiel Root -Pfad in Ihre Zwischenablage (z. B. C:/Steam/steamapps/common/Captain of Industry ).
3. Erstellen Sie eine neue Umgebungsvariable namens COI_ROOT und setzen Sie ihren Wert auf den oben kopierten Spielpfad. Verwenden Sie unter Windows das Tool für handliche Edit environmental variables . Öffnen Sie einfach das Startmenü und geben Sie Edit env ein. Sie sollten es sehen.
4. Fork/Download dieses Repo.
5. Kompilieren Sie die ExampleMod in der Release unter src/ExampleMod/ExampleMod.sln . Wir empfehlen, Visual Studio zu verwenden, aber Sie können andere Tools verwenden, z. B. den Befehl dotnet build -Konsole. In Visual Studio sollten Sie alle abhängigen Baugruppen korrekt verknüpft sehen. Wenn nicht, und Sie sehen viele Fehler, überprüfen Sie die Variable um Environmental COI_ROOT und starten Sie neu.
6. Suchen Sie die resultierende ExampleMod.dll in /bin/Release/net471 .
7. Suchen Sie Ihren COI -Datendateien -Ordner (wo Speichern oder Screenshots sind). Standardmäßig ist es bei %APPDATA%/Captain of Industry .
8. Mods öffnen oder erstellen. Erstellen Sie darin ein neues Verzeichnis, das den gleichen Namen wie Ihre Mod -DLL hat, in unserem Fall ist es ExampleMod . Kopieren Sie die %APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll ExampleMod.dll . Beachten Sie, dass der Verzeichnisname und der DLL -Name übereinstimmen müssen.
9. Starten Sie das Spiel und ermöglichen in Miscellaneous Einstellungen den Modus der Mod -Unterstützung und starten Sie das Spiel neu, damit die Einstellung wirksam wird.
10. Starten Sie ein neues Spiel und stellen Sie fest, dass die ExampleMod durch die Suche nach einem neuen Knoten im Forschungsbaum geladen wird (offen mit G -Schlüssel). Unter Prüfung von Fehlern untersuchen Sie die Protokolle im %APPDATA%/Captain of Industry/Logs Directory.
11. Herzlichen Glückwunsch, Sie betreiben jetzt Ihren Mod in Captain of Industry!

Vermögenswerte Schöpfung

Assets wie Icons oder 3D -Modelle können mit dem Unity Editor erstellt werden. Wir verwenden derzeit die Einheit 2022.3.5f1 und es wird empfohlen, dieselbe Version zu verwenden, um Inkompatibilitäten zu vermeiden.

Einheit ein Setup

Einmaliges Einheitssetup, das Mafi-Tools ordnungsgemäß funktionieren, benötigt.

1. Download und installieren Sie die Einheit 2022.3.5f1 von https://unity3d.com/unity/qa/lts-releases.
2. Suchen Sie die Testszene in src/ExampleMod.Unity . Öffne es noch nicht.
3. Erstellen Sie einen Verzeichnis -Link namens UnityRootSymlink in srcExampleMod.UnityLibrary , der auf den Unity -Installationsordner verweist (z. B. C:Program FilesUnityHubEditor2022.3.5f1 ). Dies kann durch Aufrufen mklink /D <target> <srouce> -Befehl im Konsolenfenster mit Administratorrechten erfolgen. Zum Beispiel: mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" . Wenn Sie zum UnityRootSymlink navigieren, sollten Sie ein einzelnes Editor darin sehen.
4. Erstellen Sie Hardlinks für die erforderlichen DLLs aus Ihrer Steam-Installation, indem Sie die src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat BATCH-Datei ausführen. Sie müssen es unter Admin-Berechtigungen ausführen (klicken Sie mit der rechten Maustaste, als Administrator ausführen).
   • Es ist eine gute Praxis, jeden Code zu betrachten, den Sie unter Administratorrechten ausführen. Überprüfen Sie daher zunächst die Stapeldatei.
   • Alternativ können Sie auch die betreffenden DLLs in dieses Verzeichnis kopieren, aber der harte Link ist besser, da die Aktualisierung der Originaldateien ausbreitet.
5. Öffnen Sie die Testszene von src/ExampleMod.Unity/Assets/ExampleModScene.unity im Unity Editor. Dies kann über Unity Hub erfolgen, indem Open project from disk auf der Registerkarte Projects ausgewählt wird. Stellen Sie sicher, dass Sie die richtige Einheitversion auswählen, wenn Sie mehrere installiert haben.
6. Stellen Sie sicher, dass Sie MaFi im oberen Menü des Unity Editors sehen können. Wenn nicht, wurden verknüpfte DLLs nicht ordnungsgemäß geladen und Sie können keine Vermögenswerte erstellen.
7. Öffnen Sie die ExampleModScene für Doppelklicke im Proejct Bereich (es unterliegt das Verzeichnis Assets ).
8. (Optional) Wir empfehlen auch, die folgenden Einstellungen im Unity -Editor zu ändern ( Edit -> Preferences ).
   • External tools -> External script editor -> Open by file extension . Dadurch wird die Regeneration von Projektdateien eingestellt und absolute Pfade anstelle von Verwandten platziert.
   • General -> Disable Editor Analytics (wenn Sie können und wollen).

Schaffung von Icon -Vermögenswerten

Befolgen Sie die folgenden Schritte, wie Sie Symbole verpacken, zum Beispiel für neue Produkte.

1. Wir empfehlen, Vermögenswerte in Verzeichnissen zu organisieren. Im Verzeichnis Assets Create <mod name>/<icons categor> Verzeichnis, das in unserem Fall ExampleMod/ProductIcons ist.
2. Importieren Sie Bilder als PNG- oder JPG -Dateien in das neu erstellte Verzeichnis.
3. Konfigurieren Sie neu importierte Texturen so, dass Sprite (2D and UI) -Typ haben, und wenden Sie die Änderung an.
4. Weisen Sie die neu importierten Texturen im Dropdown-Menü unten auf der Registerkarte Inspektor jedem Asset-Bundle zu. Sie können ein neues Bundle namens asdf erstellen oder vorhandene auswählen.
5. Um ein Symbol in Ihrem Mod zu verwenden (z. B. als Produktsymbol), klicken Sie einfach mit der rechten Maustaste auf eine Textur und wählen Sie Copy Path . Dieser Weg kann verwendet werden, um Ihr Präfit im Spiel zu laden.
6. Befolgen Sie die Schritte unter den Packaging Asset -Bundles, um die erstellten Vermögenswerte zu verpacken.

HINWEIS: Im Gegensatz zu 3D -Modellen müssen Texturen kein prefab erstellen.

Schaffung des 3D -Modellvermögens

In den folgenden Schritten wird beschrieben, wie eine 3D -Modellvorlage erstellt wird, die bei der Erstellung von 3D -Gebäudemodellen sehr gut zugunsten ist.

1. Definieren Sie eine Layoutentität in Ihrem Mod mit dem gewünschten Layout, das mit ASCII angegeben ist (siehe ExampleMachineData.cs ).
2. Setzen Sie den Prefab -Pfad auf "TODO" da wir noch kein Präfababschnitt haben.
3. Kompilieren und bereitstellen Sie den Mod.
4. Starten Sie das Spiel mit dem neu erstellten Maschine und führen Sie Konsolenbefehl generate_layout_entity_mesh_template aus, gefolgt von Ihrer Entity -ID. Dadurch wird eine OBJ -Datei in %APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates generiert, was ein 3D -Begrenzungsbox mit Layout Ihres neuen Unternehmens mit genauen Portorten darstellt.
5. Wenn Sie kein 3D -Modell haben, laden Sie das neu erstellte Vorlagenmodell in einen 3D -Editor Ihrer Wahl und erstellen Sie ein 3D -Modell, das es passt. Wenn Sie bereits ein 3D -Modell haben, können Sie es mit der generierten Vorlage vergleichen und das ASCII -Layout entsprechend bearbeiten.
6. Wenn das 3D -Modell abgeschlossen ist, exportieren Sie FBX oder OBJ und befolgen Sie die nächsten Schritte.

Befolgen Sie die folgenden Schritte, wie ein 3D -Modell verpackt wird.

1. Wir empfehlen, Vermögenswerte in Verzeichnissen zu organisieren. Im Verzeichnis Assets Create <mod name>/<model name> Verzeichnis, in unserem Fall, das ExampleMod/ExampleModel .
2. Importieren Sie 3D -Modelldateien (OBJ, FBX usw.) und Texturen (PNG, JPG usw.) in das Modellverzeichnis. Sie können einfach Drag & Drop verwenden. Das Erstellen eines separaten Ordners für jedes Vermögenswert wird empfohlen.
3. Ziehen Sie das 3D -Modell aus dem Projektbereich in die Einheitsszene. Setzen Sie seine Position und Drehung mit Inspector auf alle Nullen zurück (Sie können das Menü Drei Punkte neben der Transformation verwenden) und lassen Sie ihn so aussehen, wie Sie möchten (Material hinzufügen usw.). HINWEIS: Es ist wichtig, dass Ihr Vermögenswert keine Position und Drehung aufweist. Wenn Sie es neu positionieren müssen, ändern Sie das 3D -Modell oder erstellen Sie ein untergeordnetes Objekt, das bewegt werden kann.
4. Erstellen Sie ein Prefab, indem Sie das Stammobjekt ziehen und in den Projektbereich fallen lassen. Dadurch wird eine neue .prefab -Datei erstellt. In unserem Beispiel haben wir das Präfab im Verzeichnis <mod name> erstellt.
5. Weisen Sie das neu erstellte Prefab jedem Asset-Bundle aus dem Dropdown-Menü unten auf der Registerkarte Inspektor zu. Sie können ein neues temporäres Bundle namens asdf erstellen oder vorhandene auswählen.
6. Um Prefabs in Ihrem Mod zu verwenden, klicken Sie einfach mit der rechten Maustaste auf jeden Vorfeld und wählen Sie Copy Path . Dieser Weg kann verwendet werden, um Ihr Präfit im Spiel zu laden.
7. Befolgen Sie die Schritte unter den Packaging Asset -Bundles, um die erstellten Vermögenswerte zu verpacken.

Verpackungsvermögen Bündel

Sobald Ihre Vermögenswerte fertig sind, befolgen Sie diese Schritte, um sie mit Ihrem Mod zu verpacken. Mods werden in einem Verzeichnis mit demselben Namen wie Ihre Mod -DLL veröffentlicht. In unserem Fall haben wir ExampleMod/ExampleMod.dll . Jetzt können wir demselben Verzeichnis Vermögensbündel hinzufügen.

1. Stellen Sie sicher, dass alles in der Einheit gespeichert wird (verwenden Sie Ctrl+S ).
2. Erstellen Sie Asset-Bündel, indem Sie mit der rechten Maustaste im Projektbereich (in einer beliebigen Datei oder im leeren Bereich) mit der rechten Maustaste klicken und [MaFi] Build asset bundles . Nach der Verarbeitung von Unity finden Sie Asset -Bundle -Dateien im Verzeichnis src/ExampleMod.Unity/AssetBundles .
3. Kopieren Sie den Inhalt des src/ExampleMod.Unity/AssetBundles in den Ordner AssetBundles neben mod dll, z. B. %APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles .
4. (Optional) Wenn Sie es ordentlich machen möchten, benötigen Sie wirklich nur die Asset -Bundles (Dateien in Format YourPrefabName_xxxx , ohne Erweiterung) und die Datei mafi_bundles.manifest . Alle anderen .manifest -Dateien können ebenso entfernt sowie die AssetBundles -Datei entfernt werden.

Wenn Sie Änderungen an Ihren Vorstellungen durchführen, bauen Sie einfach Asset -Bündel wieder auf und kopieren Sie die neuen Dateien aus dem Verzeichnis AssetBundles .