Captain of industry modding

産業改造のキャプテン

業界のキャプテンのための公式の改造リソースへようこそ。

改造サポートのステータス

現在、COIはSteamで利用可能で、早期アクセス段階にあります。改造は可能ですが、公式にはまだサポートされていません。私たちは、改造のサポートとドキュメントの改善に継続的に取り組んでいます。

質問、問題

MODサポートは実験的であり、APIには壊れた変更がある可能性があることに注意してください。問題が発生している場合は、常に%APPDATA%/Captain of Industry/Logsのログを調べてください。それらには多くの有用な情報が含まれています。コミュニティや開発者とのトピックの改造について話し合いたい場合は、Discord Channel＃Modding-Dev-Generalにアクセスしてください（ #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 。
2. ゲームルートパスをクリップボードにコピーします（例： C:/Steam/steamapps/common/Captain of Industry ）。
3. COI_ROOTと呼ばれる新しい環境変数を作成し、その値を上にコピーしたゲームルートパスに設定します。 Windowsで、Handy Edit environmental variablesツールを使用して、[スタート]メニューを開き、 Edit env入力すると、表示されるはずです。
4. フォーク/このレポをダウンロードしてください。
5. src/ExampleMod/ExampleMod.slnにあるRelease構成でExampleModコンパイルします。 Visual Studioを使用することをお勧めしますが、 dotnet build Consoleコマンドなど、他のツールを自由に使用してください。 Visual Studioでは、すべての従属アセンブリが正しくリンクされていることがわかります。そうでない場合は、多くのエラーが表示されている場合は、環境COI_ROOT変数を確認して、再起動を試みてください。
6. 結果のExampleMod.dll in /bin/Release/net471を見つけます。
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. 新しいゲームを起動し、調査ツリーに新しいノードを見つけてExampleModがロードされていることを観察します（ Gキーを使用して開く）。エラーが発生した場合、 %APPDATA%/Captain of Industry/Logsのログを調べます。
11. おめでとうございます、あなたは今、業界のキャプテンであなたのmodを運営しています！

資産の作成

ICONや3Dモデルなどの資産は、Unityエディターを使用して作成できます。現在、Unity 2022.3.5F1を使用しており、同じバージョンを使用して互換性を回避することをお勧めします。

Unityセットアップ

MAFIツールが適切に機能するために必要な1回限りのUnityセットアップ。

1. https://unity3d.com/unity/qa/lts-releasesからUnity 2022.3.5F1をダウンロードしてインストールします。
2. src/ExampleMod.Unityのテストシーンを見つけます。まだ開かないでください。
3. srcExampleMod.UnityLibrary C:Program FilesUnityHubEditor2022.3.5f1 UnityRootSymlinkというディレクトリリンクを作成します。これは、管理者の特権を使用してコンソールウィンドウでmklink /D <target> <srouce>コマンドを呼び出すことで実行できます。例： mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" 。 UnityRootSymlinkに移動すると、単一のEditorディレクトリが表示されます。
4. src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.batバッチファイルを実行して、蒸気インストールから必要なdllにハードリンクを作成します。管理者特権の下で実行する必要があります（右クリック、管理者として実行）。
   • 管理権の下で実行されているコードを調べることをお勧めしますので、最初にバッチファイルを検査してください。
   • または、問題のDLLをこのディレクトリにコピーすることもできますが、元のファイルの更新が伝播するため、ハードリンクの方が優れています。
5. src/ExampleMod.Unity/Assets/ExampleModScene.unity in the Unity Editorからテストシーンを開きます。これは、 ProjectsタブでOpen project from disk選択することにより、Unity Hubを介して実行できます。複数のインストールがある場合は、適切なUnityバージョンを選択してください。
6. UnityエディターのトップメニューにMaFiが表示されることを確認してください。そうでない場合、リンクされたDLLは適切にロードされておらず、資産を作成できません。
7. Proejctペイン（ Assets Directoryの下にあります）でダブルクリッキンしてExampleModScene開きます。
8. （オプション）また、Unity Editorで次の設定を変更することをお勧めします（ Edit - > Preferences ）。
   • External tools - > External script editor - > Open by file extension 。これにより、プロジェクトファイルの再生を停止し、相対的ではなく絶対パスの配置を停止します。
   • General - > Disable Editor Analytics （可能な場合は必要な場合）。

アイコン資産の作成

次の手順では、たとえば新製品のアイコンをパッケージ化する方法について説明します。

1. ディレクトリで資産を整理することをお勧めします。 Assets Directoryの下で、 <mod name>/<icons categor> ExampleMod/ProductIconsを作成します。
2. PNGまたはJPGファイルとして画像を新しく作成したディレクトリにインポートします。
3. 新しくインポートされたテクスチャを構成して、 Sprite (2D and UI)タイプを作成し、変更を適用します。
4. [インスペクター]タブの下部にあるドロップダウンメニューから、新しくインポートされたテクスチャを任意のアセットバンドルに割り当てます。 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が続きます。これにより、正確なポートロケーションを持つ新しいエンティティのレイアウトの3D境界ボックスを表す%APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplatesのOBJファイルが生成されます。
5. 3Dモデルがない場合は、新しく作成したテンプレートモデルを選択した3Dエディターにロードし、適合する3Dモデルを作成します。すでに3Dモデルを持っている場合は、それを生成されたテンプレートと比較して、それに応じてASCIIレイアウトを編集できます。
6. 3Dモデルが完了したら、FBXまたはOBJをエクスポートし、次のステップに従います。

次の手順は、3Dモデルのパッケージ化方法について説明します。

1. ディレクトリで資産を整理することをお勧めします。 Assets Directoryの下で、 <mod name>/<model name>ディレクトリを作成します。この場合は、 ExampleMod/ExampleModelです。
2. 3Dモデルファイル（OBJ、FBXなど）とテクスチャ（PNG、JPGなど）をモデルディレクトリにインポートします。ドラッグアンドドロップを使用するだけです。資産ごとに個別のフォルダーを作成することをお勧めします。
3. 3DモデルをProject PaneからUnityシーンにドラッグします。インスペクターを使用してすべてのゼロに位置と回転をリセットし（次に3つのドットメニューを使用して変換することができます）、必要に応じて見えるようにします（材料などを追加）。注：あなたの資産がゼロの位置と回転を持っていることが重要です。再配置する必要がある場合は、3Dモデルを変更するか、移動できる子オブジェクトを作成します。
4. ルートオブジェクトをドラッグし、プロジェクトペインにドロップしてプレハブを作成します。これにより、新しい.prefabファイルが作成されます。この例では、 <mod name>ディレクトリにプレハブを作成しました。
5. [検査官]タブの下部にあるドロップダウンメニューから、新しく作成されたプレハブを任意のアセットバンドルに割り当てます。 asdfと呼ばれる新しい一時的なバンドルを作成するか、既存のバンドルを選択できます。
6. MODでプレハブを使用するには、任意のプレハブを右クリックしてCopy Pathを選択します。そのパスは、ゲームにプレハブをロードするために使用できます。
7. パッケージアセットバンドルの下の手順に従って、作成された資産をパッケージ化します。

パッケージングアセットバンドル

資産の準備ができたら、次の手順に従って、MODでパッケージ化します。 MODは、mod dllと同じ名前のディレクトリに公開されています。この場合、 ExampleMod/ExampleMod.dllがあります。これで、同じディレクトリにアセットバンドルを追加できます。

1. 団結のすべてが保存されていることを確認します（ Ctrl+Sを使用してください）。
2. プロジェクトペイン（ファイルまたは空の領域）のどこでも右クリックしてアセットバンドルを構築し、 [MaFi] Build asset bundles 。 Unityが処理された後、Asset Bundleファイルはsrc/ExampleMod.Unity/AssetBundlesディレクトリにあります。
3. src/ExampleMod.Unity/AssetBundlesの内容%APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles mod dllの横にあるAssetBundlesフォルダーにコピーします。
4. （オプション）きちんとしたい場合は、実際にアセットバンドル（拡張機能なしでYourPrefabName_xxxx形式のファイル）とmafi_bundles.manifestファイルのみが必要です。他のすべての.manifestファイルは、 AssetBundlesファイルと同様に削除できます。

プレハブに変更がある場合は、Asset Bundlesを再構築して、 AssetBundlesディレクトリから新しいファイルを使用してコピーするだけです。