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欄目錄中的新文件即可。