Captain of industry modding

行业改装队长

欢迎来到行业船长的官方改装资源。

改装支持状态

COI目前在Steam上可用，并且在早期访问阶段。虽然可以进行修改，但尚未得到正式支持。我们一直在努力改善改装支持和文档。

问题，问题

请注意，MOD支持是实验性的，API可能会发生破坏。如果您有问题，请始终检查%APPDATA%/Captain of Industry/Logs目录中的日志，它们包含许多有用的信息。如果您想与社区和开发人员讨论改装主题，请访问我们的Discord频道＃MIDDDING-DEV将军（您需要在#pick-your-roles-here频道中为自己分配Mod creation角色）。您还可以在GitHub上提交问题，但是我们团队的响应时间可能会延迟。

先决条件

为了开始改装COI，您将需要：

1. 自己的工业船长在Steam上并安装了游戏。
2. 安装了.NET框架4.7.1。
3. （可选）安装了Unity 2022.3.5F1（仅用于资产创建）。

入门

1. 通过右键单击Steam客户端 - > Properties... > Local Files - > Browse中的游戏标题上的游戏标题上的COI游戏文件。
2. 将游戏的根路径复制到剪贴板（例如C:/Steam/steamapps/common/Captain of Industry ）。
3. 创建一个称为COI_ROOT的新环境变量，并将其值设置为上面复制的游戏根路径。在Windows上，使用方便的Edit environmental variables工具，只需打开“开始”菜单并键入Edit env ，您应该看到它。
4. 叉/下载此回购。
5. 在位于src/ExampleMod/ExampleMod.sln的Release配置中编译ExampleMod 。我们建议使用Visual Studio，但可以随意使用任何其他工具，例如dotnet build Console命令。在Visual Studio中，您应该看到正确链接的所有因组件。如果没有，并且您看到了很多错误，请检查您的环境COI_ROOT变量，请尝试重新启动。
6. 在/bin/Release/net471中找到所得的ExampleMod.dll 。
7. 查找您的COI数据文件文件夹（保存或屏幕截图所在）。默认情况下，它为%APPDATA%/Captain of Industry 。
8. 打开或创建目录Mods 。在其中，创建一个新目录，该目录的名称与您的mod dll相同，在我们的情况下，它是ExampleMod 。在此复制编译的ExampleMod.dll ，以便它为%APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll 。请注意，目录名称和DLL名称必须匹配。
9. 启动游戏并在Miscellaneous设置中启用MOD支持并重新启动游戏，以便设置生效。
10. 启动一个新游戏，并观察到通过在研究树中找到一个新节点（使用G键打开）来加载ExampleMod 。如果发生任何错误，请检查%APPDATA%/Captain of Industry/Logs中的日志。
11. 恭喜，您现在正在行业船长运行mod！

资产创造

可以使用Unity编辑器来创建图标或3D模型之类的资产。我们目前使用Unity 2022.3.5F1，建议使用相同的版本来避免不兼容。

Unity设置

MAFI工具正常运行所需的一次性Unity设置。

1. 从https://unity3d.com/unity/qa/lts-releases下载并安装Unity 2022.3.5F1。
2. 在src/ExampleMod.Unity中找到测试场景。不要打开它。
3. 创建一个指向Unity安装文件夹（例如C:Program FilesUnityHubEditor2022.3.5f1 ）的srcExampleMod.UnityLibrary中的名为UnityRootSymlink的目录链接。这可以通过使用Admin Priviliges中的控制台窗口中调用mklink /D <target> <srouce>命令来完成。例如： mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" 。当您导航到UnityRootSymlink时，您应该在其中看到一个单个Editor目录。
4. 通过运行src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat批处理文件，为您的Steam安装中的必要DLL创建硬链链接。您需要在管理特权（右键单击，作为管理员运行）下运行它。
   • 最好查看您在管理特权下运行的任何代码，因此请首先检查批处理文件。
   • 另外，您也可以将相关DLL复制到此目录中，但是硬链接更好，因为对原始文件的任何更新都会传播。
5. 从src/ExampleMod.Unity/Assets/ExampleModScene.unity中打开测试场景。这可以通过Unity Hub从Projects选项卡中Open project from disk来完成。如果安装了多个，请确保选择正确的Unity版本。
6. 验证您可以在Unity编辑器上的顶部菜单中看到MaFi 。如果没有，链接的DLL无法正确加载，您将无法创建资产。
7. 通过双粘蛋白在Proejct窗格中（在Assets目录下）打开ExampleModScene 。
8. （可选）我们还建议在Unity编辑器（ Edit - > Preferences ）中更改以下设置。
   • External tools - > External script editor - > Open by file extension 。这将停止再生项目文件并放置绝对路径而不是相对。
   • General - > Disable Editor Analytics （如果可以的话，请）。

创建图标资产

以下步骤描述了如何打包图标，例如新产品。

1. 我们建议在目录中组织资产。在Assets目录下，创建<mod name>/<icons categor>目录，在我们的情况下是ExampleMod/ProductIcons 。
2. 将图像作为PNG或JPG文件导入到新创建的目录。
3. 配置新导入的纹理以具有Sprite (2D and UI)类型并应用更改。
4. 将新导入的纹理分配给“ Inspector”选项卡底部的下拉菜单中的任何资产捆绑包。您可以创建一个名为asdf的新捆绑包或选择任何现有的捆绑包。
5. 要在mod中使用图标（例如，作为产品图标），只需右键单击纹理上，然后选择Copy Path 。该路径可用于在游戏中加载预制。
6. 按照包装资产捆绑包下的步骤包装创建的资产。

注意：与3D型号不同，纹理不需要创建prefab 。

创建3D模型资产

以下步骤描述了如何创建一个在创建3D建筑物模型的3D模型模板。

1. 使用使用ASCII指定的所需布局在您的MOD中定义一个布局实体（请参阅ExampleMachineData.cs ）。
2. 将预制路径设置为"TODO"因为我们还没有预制。
3. 编译和部署mod。
4. 使用新创建的计算机启动游戏，并运行控制台命令generate_layout_entity_mesh_template然后是您的实体ID。这将在%APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates中生成一个OBJ文件，该文件代表您新实体的3D边界布局，并具有精确的端口位置。
5. 如果您没有3D模型，请加载新创建的模板模型到您选择的3D编辑器，并创建适合它的3D模型。如果您已经有3D模型，则可以将其与生成的模板进行比较，并相应地编辑ASCII布局。
6. 3D模型完成后，导出FBX或OBJ并按照下一步。

以下步骤描述了如何打包3D模型。

1. 我们建议在目录中组织资产。在Assets目录下，创建<mod name>/<model name>目录，在我们的情况下是ExampleMod/ExampleModel 。
2. 将3D模型文件（OBJ，FBX等）和纹理（PNG，JPG等）导入模型目录。您可以简单地使用拖放。建议为每个资产创建一个单独的文件夹。
3. 将3D模型从项目窗格拖到团结场景。使用Inspector将其位置和旋转重置为所有零（您可以使用旁边的三个点菜单），并使其看起来如需（添加材料等）。注意：重要的是您的资产具有零位置和旋转。如果需要重新定位它，请更改3D模型或制作可以移动的子对象。
4. 通过拖动根对象并将其删除到项目窗格中来创建预制。这将制作一个新的.prefab文件。在我们的示例中，我们在<mod name>目录中创建了预制。
5. 从“ Inspector”选项卡底部的下拉菜单中分配新创建的预制套件。您可以创建一个名为asdf新临时捆绑包或选择任何现有的捆绑包。
6. 要在mod中使用预制措施，只需右键单击任何预制措施，然后选择Copy Path 。该路径可用于在游戏中加载预制。
7. 按照包装资产捆绑包下的步骤包装创建的资产。

包装资产捆绑包

资产准备就绪后，请按照以下步骤将其包装为您的mod。 mods以与您的mod dll相同的目录发布，在我们的情况下，我们具有ExampleMod/ExampleMod.dll 。现在，我们可以在同一目录中添加资产捆绑包。

1. 确保保存Unity的所有内容（使用Ctrl+S ）。
2. 通过右键单击项目窗格（任何文件或空区域）中的任何位置，然后选择[MaFi] Build asset bundles 。完成UNITY处理后，可以在src/ExampleMod.Unity/AssetBundles目录中找到资产捆绑文件。
3. 复制src/ExampleMod.Unity/AssetBundles的内容到MOD DLL旁边的AssetBundles文件夹，例如%APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles 。
4. （可选）如果您想整洁，则实际上只需要资产捆绑包（格式的文件YourPrefabName_xxxx ，而无需扩展）和mafi_bundles.manifest文件。所有其他.manifest文件都可以删除以及AssetBundles文件。

如果您对预制措施进行任何更改，只需重建资产捆绑包，然后复制使用AssetBundles栏目录中的新文件即可。