Captain of industry modding

Capitaine du modding de l'industrie

Bienvenue dans la ressource de modding officielle pour le jeu du capitaine de l'industrie.

Statut du support de modding

COI est actuellement disponible sur Steam et il est en phase d'accès précoce. Bien que le modding soit possible, il n'est pas encore officiellement soutenu. Nous travaillons continuellement sur l'amélioration du support et de la documentation du modding.

Questions, problèmes

Notez que le support MOD est expérimental et les API pourraient avoir des changements de rupture. Si vous rencontrez des problèmes, examinez toujours les journaux dans le répertoire %APPDATA%/Captain of Industry/Logs , ils contiennent beaucoup d'informations utiles. Si vous souhaitez discuter de sujets de modding avec la communauté et les développeurs, visitez notre canal Discord # modding-dev-général (vous devrez vous attribuer un rôle Mod creation dans le canal #pick-your-roles-here ). Vous pouvez également déposer des problèmes ici sur GitHub, mais le temps de réponse de notre équipe pourrait être retardé.

Condition préalable

Afin de commencer à modding COI, vous devrez:

1. Propre capitaine de l'industrie sur Steam et que le jeu installe.
2. Installation de .NET Framework 4.7.1.
3. (Facultatif) ont Unity 2022.3.5f1 installé (nécessaire uniquement pour la création d'actifs).

Commencer

1. Localisez les fichiers de jeu COI via un clic droit sur le titre du jeu dans le client Steam -> Properties... -> Local Files -> Browse .
2. Copiez le chemin racine du jeu vers votre presse-papiers (par exemple C:/Steam/steamapps/common/Captain of Industry ).
3. Créez une nouvelle variable environnementale appelée COI_ROOT et définissez sa valeur sur le chemin racine du jeu copié ci-dessus. Sur Windows, utilisez l'outil Handy Edit environmental variables , ouvrez simplement le menu Démarrer et tapez Edit env et vous devriez le voir.
4. Fork / Télécharger ce dépôt.
5. Compilez l' ExampleMod dans la configuration Release située à src/ExampleMod/ExampleMod.sln . Nous vous recommandons d'utiliser Visual Studio, mais n'hésitez pas à utiliser d'autres outils, tels que la commande dotnet build Console. Dans Visual Studio, vous devriez voir tous les assemblages dépendants liés correctement. Sinon, et vous voyez beaucoup d'erreurs, vérifiez votre variable COI_ROOT environnementale, essayez de redémarrer.
6. Localisez l' ExampleMod.dll résultant dans /bin/Release/net471 .
7. Trouvez votre dossier de fichiers de données COI (où se trouvent des enregistrements ou des captures d'écran). Par défaut, il se trouve à %APPDATA%/Captain of Industry .
8. Ouvrir ou créer Mods de répertoire. À l'intérieur, créez un nouveau répertoire qui a le même nom que votre DLL MOD, dans notre cas, c'est ExampleMod . Copiez le compilé ExampleMod.dll , afin qu'il soit à %APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll . Notez que le nom du répertoire et le nom de la DLL doivent correspondre.
9. Lancez le jeu et dans les paramètres Miscellaneous permettent la prise en charge du mod et redémarrez le jeu afin que le paramètre prenne effet.
10. Lancez un nouveau jeu et observez que l' ExampleMod est chargé en localisant un nouveau nœud dans l'arborescence de recherche (ouvrir à l'aide de la clé G ). En cas d'erreurs, examinez les journaux dans le répertoire %APPDATA%/Captain of Industry/Logs .
11. Félicitations, vous dirigez maintenant votre mod dans Captain of Industry!

Création d'actifs

Des actifs tels que des icônes ou des modèles 3D peuvent être créés à l'aide de l'éditeur Unity. Nous utilisons actuellement Unity 2022.3.5f1 et il est recommandé d'utiliser la même version pour éviter les incompatibilités.

Configuration de l'unité

Configuration d'unité unique nécessaire pour que les outils MAFI fonctionnent correctement.

1. Téléchargez et installez Unity 2022.3.5f1 à partir de https://unity3d.com/unity/qa/lts-releases.
2. Localisez la scène de test dans src/ExampleMod.Unity . Ne l'ouvrez pas encore.
3. Créez un lien de répertoire appelé UnityRootSymlink dans srcExampleMod.UnityLibrary qui pointe vers le dossier d'installation d'Unity (par exemple C:Program FilesUnityHubEditor2022.3.5f1 ). Cela peut être fait en invoquant la commande mklink /D <target> <srouce> dans la fenêtre de la console avec des privilières d'administration. Par exemple: mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" . Lorsque vous naviguez vers le UnityRootSymlink vous devriez y voir un répertoire Editor unique.
4. Créez des liens rigide pour les DLL nécessaires à partir de votre installation Steam en exécutant le src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat Fichier batch. Vous devrez l'exécuter sous privilèges d'administration (cliquez avec le bouton droit, exécutez en tant qu'administrateur).
   • C'est une bonne pratique d'examiner tout code que vous exécutez sous les privilèges d'administration, alors n'hésitez pas à inspecter le fichier batch en premier.
   • Alternativement, vous pouvez également copier les DLL en question dans ce répertoire, mais le lien dur est meilleur car toute mise à jour des fichiers d'origine se propagera.
5. Ouvrez la scène de test de src/ExampleMod.Unity/Assets/ExampleModScene.unity dans l'éditeur Unity. Cela peut être fait via Unity Hub en sélectionnant Open project from disk dans l'onglet Projects . Assurez-vous de sélectionner la bonne version Unity si vous avez plusieurs installés.
6. Vérifiez que vous pouvez voir MaFi dans le menu supérieur de l'éditeur Unity. Sinon, les DLL liés n'étaient pas correctement chargés et vous ne pourrez pas créer des actifs.
7. Ouvrez l' ExampleModScene par Double-Clickin dessus dans le volet Proejct (il est sous répertoire Assets ).
8. (Facultatif) Nous recommandons également de modifier les paramètres suivants dans l'éditeur Unity ( Edit -> Preferences ).
   • External tools -> External script editor -> Open by file extension . Cela empêchera la régénération des fichiers de projet et la mise en place de chemins absolus au lieu de relatives.
   • General -> Disable Editor Analytics (si vous pouvez et le souhaitez).

Création d'actifs icônes

Les étapes suivantes décrivent comment emballer les icônes, par exemple pour de nouveaux produits.

1. Nous vous recommandons d'organiser des actifs dans les répertoires. Sous le répertoire Assets Créer <mod name>/<icons categor> répertoire, dans notre cas qui est ExampleMod/ProductIcons .
2. Importez des images sous forme de fichiers PNG ou JPG dans le répertoire nouvellement créé.
3. Configurez les textures nouvellement importées pour avoir un type Sprite (2D and UI) et appliquez la modification.
4. Attribuez les textures nouvellement importées à n'importe quel bundle d'actifs à partir du menu déroulant en bas de l'onglet Inspecteur. Vous pouvez créer un nouveau bundle appelé asdf ou en choisir un existant.
5. Pour utiliser une icône dans votre mod (par exemple comme icône de produit), cliquez simplement avec le bouton droit sur une texture et sélectionnez Copy Path . Ce chemin peut être utilisé pour charger votre Prefab dans le jeu.
6. Suivez les étapes sous les forfaits d'actifs d'emballage pour emballer les actifs créés.

Remarque: Contrairement aux modèles 3D, les textures n'ont pas besoin de créer un prefab .

Création de l'actif du modèle 3D

Les étapes suivantes décrivent comment créer un modèle de modèle 3D qui est très bénéfique dans la création de modèles 3D de bâtiments.

1. Définissez une entité de mise en page dans votre mod avec la disposition souhaitée spécifiée à l'aide d'ASCII (voir ExampleMachineData.cs ).
2. Définissez le chemin préfabriqué vers "TODO" car nous n'avons pas encore de préfabriqué.
3. Compiler et déployer le mod.
4. Lancez le jeu avec la nouvelle machine et exécutez la commande Console generate_layout_entity_mesh_template suivie de votre ID entité. Cela générera un fichier OBJ dans %APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates qui représente une boîte de limite 3D de mise en page de votre nouvelle entité avec des emplacements de port exacts.
5. Si vous n'avez pas de modèle 3D, chargez le modèle de modèle nouvellement créé à un éditeur 3D de votre choix et créez un modèle 3D qui lui convient. Si vous avez déjà un modèle 3D, vous pouvez le comparer au modèle généré et modifier la disposition ASCII en conséquence.
6. Lorsque le modèle 3D est terminé, exportez FBX ou OBJ et suivez les étapes suivantes.

Les étapes suivantes décrivent comment emballer un modèle 3D.

1. Nous vous recommandons d'organiser des actifs dans les répertoires. Sous le répertoire Assets Create <mod name>/<model name> Répertoire, dans notre cas, ExampleMod/ExampleModel .
2. Importez des fichiers de modèle 3D (OBJ, FBX, etc.) et des textures (PNG, JPG, etc.) dans le répertoire du modèle. Vous pouvez simplement utiliser Drag & Drop. La création d'un dossier séparé pour chaque actif est recommandée.
3. Faites glisser le modèle 3D du volet Project vers la scène unité. Réinitialisez sa position et sa rotation à tous les zéros à l'aide de l'inspecteur (vous pouvez utiliser le menu à trois points à côté de la transformation) et le rendre comme vous le souhaitez (ajouter des matériaux, etc.). Remarque: il est important que votre actif ait une position et une rotation nulles. Si vous avez besoin de le repositionner, modifiez le modèle 3D ou faites un objet enfant qui peut être déplacé.
4. Créez un préfabriqué en faisant glisser l'objet racine et en le déposant dans le volet Project. Cela fera un nouveau fichier .prefab . Dans notre exemple, nous avons créé le préfabriqué dans le répertoire <mod name> .
5. Attribuez le préfabriqué nouvellement créé à n'importe quel bundle d'actifs à partir du menu déroulant en bas de l'onglet Inspecteur. Vous pouvez créer un nouveau bundle temporaire appelé asdf ou en choisir un existant.
6. Pour utiliser les préfabriqués dans votre mod, cliquez avec le bouton droit sur n'importe quel préfabriqué et sélectionnez Copy Path . Ce chemin peut être utilisé pour charger votre Prefab dans le jeu.
7. Suivez les étapes sous les forfaits d'actifs d'emballage pour emballer les actifs créés.

Bundles d'actifs d'emballage

Une fois que vos actifs sont prêts, suivez ces étapes pour les emballer avec votre mod. Les mods sont publiés dans un répertoire avec le même nom que votre DLL MOD, dans notre cas, nous avons ExampleMod/ExampleMod.dll . Maintenant, nous pouvons ajouter des faisceaux d'actifs au même répertoire.

1. Assurez-vous que tout est enregistré dans l'unité (utilisez Ctrl+S ).
2. Construisez des faisceaux d'actifs en cliquant avec le bouton droit n'importe où dans le volet du projet (sur n'importe quel fichier ou zone vide) et sélectionnez [MaFi] Build asset bundles . Une fois l'unité terminée le traitement, les fichiers de bundle d'actifs peuvent être trouvés dans le répertoire src/ExampleMod.Unity/AssetBundles .
3. Copiez le contenu du src/ExampleMod.Unity/AssetBundles dans le dossier AssetBundles à côté de Mod DLL, par exemple %APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles .
4. (Facultatif) Si vous voulez le rendre soigné, vous n'avez vraiment besoin que des bundles Asset (fichiers au format YourPrefabName_xxxx , sans extension) et le fichier mafi_bundles.manifest . Tous les autres fichiers .manifest peuvent être supprimés ainsi que le fichier AssetBundles .

Si vous effectuez des modifications à vos préfabriques, reconstruisez simplement les bundles Asset et copiez, utilisez les nouveaux fichiers à partir du répertoire AssetBundles .