Captain of industry modding

Kapten Modding Industri

Selamat datang di sumber daya modding resmi untuk kapten game industri.

Status Dukungan Modding

COI saat ini tersedia di Steam dan dalam tahap akses awal. Meskipun modding dimungkinkan, itu belum secara resmi didukung. Kami terus bekerja untuk meningkatkan dukungan dan dokumentasi modding.

Pertanyaan, masalah

Perhatikan bahwa dukungan mod bersifat eksperimental dan API mungkin mengalami perubahan. Jika Anda mengalami masalah, selalu periksa log dalam %APPDATA%/Captain of Industry/Logs , mereka berisi banyak informasi yang berguna. Jika Anda ingin mendiskusikan topik modding dengan komunitas dan devs, kunjungi Channel Discord kami #modding-dev-jenderal (Anda harus menetapkan diri Anda peran Mod creation dalam #pick-your-roles-here channel). Anda juga dapat mengajukan masalah di sini di GitHub, tetapi waktu respons dari tim kami mungkin ditunda.

Prasyarat

Untuk memulai modding coi, Anda perlu:

1. Kapten industri sendiri di Steam dan memasang permainan.
2. Miliki .NET Framework 4.7.1 Diinstal.
3. (Opsional) Memasukkan Unity 2022.3.5f1 diinstal (hanya diperlukan untuk pembuatan aset).

Memulai

1. Temukan file game COI melalui klik kanan pada judul game di Steam Client -> Properties... -> Local Files -> Browse .
2. Salin jalur root game ke clipboard Anda (misalnya C:/Steam/steamapps/common/Captain of Industry ).
3. Buat variabel lingkungan baru yang disebut COI_ROOT dan atur nilainya ke jalur root game yang disalin di atas. Di Windows, gunakan alat Edit environmental variables , cukup buka menu mulai dan ketik Edit env dan Anda harus melihatnya.
4. Garpu/unduh repo ini.
5. Kompilasi ExampleMod dalam konfigurasi Release yang terletak di src/ExampleMod/ExampleMod.sln . Kami merekomendasikan untuk menggunakan Visual Studio tetapi jangan ragu untuk menggunakan alat lain, seperti perintah dotnet build Console. Di Visual Studio Anda harus melihat semua rakitan dependen terhubung dengan benar. Jika tidak, dan Anda melihat banyak kesalahan, periksa variabel COI_ROOT lingkungan Anda, coba mulai ulang.
6. Temukan ExampleMod.dll yang dihasilkan di /bin/Release/net471 .
7. Temukan folder file data COI Anda (di mana menyimpan atau tangkapan layar). Secara default, ini adalah %APPDATA%/Captain of Industry .
8. Buka atau buat Mods direktori. Di dalamnya, buat direktori baru yang memiliki nama yang sama dengan MOD DLL Anda, dalam kasus kami itu adalah ExampleMod . Salin ExampleMod.dll yang dikompilasi di sana, sehingga pada %APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll . Perhatikan bahwa nama direktori dan nama dll harus cocok.
9. Luncurkan game dan dalam pengaturan Miscellaneous memungkinkan dukungan mod dan restart game sehingga pengaturan mulai berlaku.
10. Luncurkan game baru dan amati bahwa ExampleMod dimuat dengan menemukan simpul baru di pohon penelitian (terbuka menggunakan kunci G ). Dalam hal kesalahan apa pun, periksa log dalam %APPDATA%/Captain of Industry/Logs .
11. Selamat, Anda sekarang menjalankan mod di Kapten Industri!

Penciptaan aset

Aset seperti ikon atau model 3D dapat dibuat menggunakan editor Unity. Kami saat ini menggunakan Unity 2022.3.5F1 dan disarankan untuk menggunakan versi yang sama untuk menghindari ketidakcocokan.

Pengaturan Persatuan

Pengaturan satu kali persatuan yang diperlukan agar alat MAFI berfungsi dengan baik.

1. Unduh dan instal Unity 2022.3.5f1 dari https://unity3d.com/unity/qa/lts-releases.
2. Temukan adegan tes di src/ExampleMod.Unity . Jangan buka.
3. Buat tautan direktori yang disebut UnityRootSymlink di srcExampleMod.UnityLibrary yang menunjuk ke folder instalasi Unity (misalnya C:Program FilesUnityHubEditor2022.3.5f1 ). Ini dapat dilakukan dengan memohon perintah mklink /D <target> <srouce> di jendela konsol dengan priviliges admin. Misalnya: mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" . Saat Anda menavigasi ke UnityRootSymlink Anda akan melihat satu direktori Editor di dalamnya.
4. Buat tautan keras untuk DLL yang diperlukan dari instalasi Steam Anda dengan menjalankan src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat file batch. Anda perlu menjalankannya di bawah hak istimewa admin (klik kanan, jalankan sebagai administrator).
   • Ini adalah praktik yang baik untuk melihat kode apa pun yang Anda jalankan di bawah hak istimewa admin, jadi jangan ragu untuk memeriksa file batch terlebih dahulu.
   • Atau, Anda juga dapat menyalin DLL yang dimaksud ke direktori ini tetapi hard link lebih baik karena setiap pembaruan untuk file asli akan menyebar.
5. Buka adegan uji dari src/ExampleMod.Unity/Assets/ExampleModScene.unity in the Unity Editor. Ini dapat dilakukan melalui Unity Hub dengan memilih Open project from disk di tab Projects . Pastikan Anda memilih versi Unity yang tepat jika Anda memiliki beberapa yang diinstal.
6. Pastikan Anda dapat melihat MaFi di menu teratas pada editor Unity. Jika tidak, DLL tertaut tidak dimuat dengan benar dan Anda tidak akan dapat membuat aset.
7. Buka ExampleModScene dengan klik dua kali di dalamnya di panel Proejct (di bawah direktori Assets ).
8. (Opsional) Kami juga merekomendasikan mengubah pengaturan berikut di editor Unity ( Edit -> Preferences ).
   • External tools -> External script editor -> Open by file extension . Ini akan berhenti regenerasi file proyek dan menempatkan jalur absolut, bukan relatif.
   • General -> Disable Editor Analytics (jika Anda bisa dan inginkan).

Penciptaan aset ikon

Langkah -langkah berikut menjelaskan cara mengemas ikon, misalnya untuk produk baru.

1. Kami merekomendasikan pengorganisasian aset di direktori. Di bawah Direktori Assets Buat <mod name>/<icons categor> Direktori, dalam kasus kami yaitu ExampleMod/ProductIcons .
2. Impor gambar sebagai file PNG atau JPG ke direktori yang baru dibuat.
3. Konfigurasikan tekstur yang baru diimpor untuk memiliki tipe Sprite (2D and UI) dan terapkan perubahannya.
4. Tetapkan tekstur yang baru diimpor ke bundel aset apa pun dari menu tarik-turun di bagian bawah tab Inspektur. Anda dapat membuat bundel baru yang disebut asdf atau memilih yang sudah ada.
5. Untuk menggunakan ikon di mod Anda (misalnya sebagai ikon produk), cukup klik kanan pada tekstur dan pilih Copy Path . Jalur itu dapat digunakan untuk memuat prefab Anda dalam permainan.
6. Ikuti langkah -langkah di bawah bundel aset pengemasan untuk mengemas aset yang dibuat.

Catatan: Tidak seperti model 3D, tekstur tidak perlu membuat prefab .

Penciptaan aset model 3D

Langkah -langkah berikut menjelaskan cara membuat templat model 3D yang sangat menguntungkan dalam penciptaan model bangunan 3D.

1. Tentukan entitas tata letak di mod Anda dengan tata letak yang diinginkan yang ditentukan menggunakan ASCII (lihat ExampleMachineData.cs ).
2. Tetapkan jalur prefab ke "TODO" karena kami belum memiliki prefab.
3. Mengkompilasi dan menggunakan mod.
4. Luncurkan game dengan mesin yang baru dibuat dan jalankan perintah konsol generate_layout_entity_mesh_template diikuti oleh id entitas Anda. Ini akan menghasilkan file OBJ di %APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates yang mewakili kotak pembatas 3D tata letak entitas baru Anda dengan lokasi port yang tepat.
5. Jika Anda tidak memiliki model 3D, muat model template yang baru dibuat ke editor 3D pilihan Anda dan buat model 3D yang cocok. Jika Anda sudah memiliki model 3D, Anda dapat membandingkannya dengan templat yang dihasilkan dan mengedit tata letak ASCII.
6. Ketika model 3D selesai, ekspor FBX atau OBJ dan ikuti langkah selanjutnya.

Langkah -langkah berikut menjelaskan cara mengemas model 3D.

1. Kami merekomendasikan pengorganisasian aset di direktori. Di bawah Direktori Assets Buat <mod name>/<model name> Direktori, dalam kasus kami yaitu ExampleMod/ExampleModel .
2. Impor file model 3D (OBJ, FBX, dll.) Dan tekstur (PNG, JPG, dll) ke direktori model. Anda cukup menggunakan drag & drop. Direkomendasikan membuat folder terpisah untuk setiap aset.
3. Seret model 3D dari panel Project ke adegan persatuan. Setel ulang posisinya dan rotasi ke semua nol menggunakan inspektur (Anda dapat menggunakan menu tiga titik di sebelah untuk mengubah) dan membuatnya terlihat seperti yang Anda inginkan (tambahkan bahan, dll.). Catatan: Penting bahwa aset Anda memiliki posisi dan rotasi nol. Jika Anda perlu memposisikannya kembali, ubah model 3D atau buat objek anak yang dapat dipindahkan.
4. Buat prefab dengan menyeret objek root dan menjatuhkannya ke panel proyek. Ini akan membuat file .prefab baru. Dalam contoh kami, kami membuat prefab di direktori <mod name> .
5. Tetapkan prefab yang baru dibuat ke bundel aset apa pun dari menu tarik-turun di bagian bawah tab Inspektur. Anda dapat membuat bundel sementara baru yang disebut asdf atau memilih yang sudah ada.
6. Untuk menggunakan prefab di mod Anda, cukup klik kanan setiap prefab dan pilih Copy Path . Jalur itu dapat digunakan untuk memuat prefab Anda dalam permainan.
7. Ikuti langkah -langkah di bawah bundel aset pengemasan untuk mengemas aset yang dibuat.

Bundel aset pengemasan

Setelah aset Anda siap, ikuti langkah -langkah ini untuk mengemasnya dengan mod Anda. Mod diterbitkan dalam direktori dengan nama yang sama dengan MOD DLL Anda, dalam kasus kami, kami memiliki ExampleMod/ExampleMod.dll . Sekarang kita dapat menambahkan bundel aset ke direktori yang sama.

1. Pastikan bahwa setiap orang di Unity disimpan (gunakan Ctrl+S ).
2. Bangun bundel aset dengan mengklik kanan di mana saja di panel proyek (pada file atau area kosong apa pun) dan pilih [MaFi] Build asset bundles . Setelah Unity selesai diproses, file bundel aset dapat ditemukan di direktori src/ExampleMod.Unity/AssetBundles .
3. Salin konten dari src/ExampleMod.Unity/AssetBundles ke folder AssetBundles di sebelah mod dll, misalnya %APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles .
4. (Opsional) Jika Anda ingin membuatnya rapi, Anda benar -benar hanya membutuhkan bundel aset (file dalam format YourPrefabName_xxxx , tanpa ekstensi) dan file mafi_bundles.manifest . Semua file .manifest lainnya dapat dihapus serta file AssetBundles .

Jika Anda melakukan perubahan pada prefab Anda, cukup membangun kembali bundel aset dan salin Gunakan file baru dari direktori AssetBundles .