Captain of industry modding

Капитан моддинга промышленности

Добро пожаловать в официальный ресурс моддинга для капитана отрасли.

Статус поддержки моддинга

COI в настоящее время доступна в Steam и находится на стадии раннего доступа. Хотя моддинг возможен, он еще официально не поддерживается. Мы постоянно работаем над улучшением поддержки моддинга и документации.

Вопросы, проблемы

Обратите внимание, что поддержка MOD является экспериментальной, а API могут иметь нарушающие изменения. Если у вас возникают проблемы, всегда изучайте журналы в каталоге %APPDATA%/Captain of Industry/Logs , они содержат много полезной информации. Если вы хотите обсудить темы моддинга с сообществом и разработчиками, посетите наш канал Discord #Modding-Dev-General (вам нужно будет назначить себе роль Mod creation в канале #pick-your-roles-here ). Вы также можете подать проблемы здесь на GitHub, но время отклика от нашей команды может быть отложено.

Предварительные условия

Чтобы начать моддинг COI, вам нужно:

1. Собственный капитан промышленности в Steam и установил игру.
2. Установлен .NET Framework 4.7.1.
3. (Необязательно) иметь Unity 2022.3.5f1, установленные (необходимо только для создания активов).

Начиная

1. Найдите файлы игры COI, щелкните правой кнопкой мыши на заголовке игры в Steam Client -> Properties... -> Local Files -> Browse .
2. Скопируйте путь к корнеу игры в ваш буфер обмена (например, C:/Steam/steamapps/common/Captain of Industry ).
3. Создайте новую переменную окружающей среды под названием COI_ROOT и установите его значение для корневого пути игры, скопированного выше. В Windows используйте инструмент «Удобное Edit environmental variables , просто откройте меню «Пуск» и тип Edit env , и вы должны его увидеть.
4. Вилка/скачать это репо.
5. Скомпилируйте ExampleMod в конфигурации Release , расположенной по адресу src/ExampleMod/ExampleMod.sln . Мы рекомендуем использовать Visual Studio, но не стесняемся использовать любые другие инструменты, такие как команда консоли dotnet build . В Visual Studio вы должны увидеть все зависимые сборки, связанные правильно. Если нет, и вы видите много ошибок, проверьте переменную среды COI_ROOT , попробуйте перезапустить.
6. Найдите полученную ExampleMod.dll в /bin/Release/net471 .
7. Найдите папку файлов данных COI (где есть сохранения или скриншоты). По умолчанию это %APPDATA%/Captain of Industry .
8. Откройте или создайте Mods каталогов. Внутри него создайте новый каталог, который имеет то же имя, что и ваш мод DLL, в нашем случае это ExampleMod . Скопируйте скомпилированный ExampleMod.dll , так что он находится в %APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll . Обратите внимание, что имя каталога и имя DLL должны соответствовать.
9. Запустите игру и в Miscellaneous настройках включите поддержку MOD и перезапустите игру, чтобы настройка вступила в силу.
10. Запустите новую игру и заметьте, что ExampleMod загружаются путем поиска нового узла в дереве исследований (Open с использованием G -ключа). В случае любых ошибок изучите журналы в %APPDATA%/Captain of Industry/Logs .
11. Поздравляю, теперь вы используете свой мод в капитане промышленности!

Создание активов

Активы, такие как значки или 3D -модели, могут быть созданы с использованием редактора Unity. В настоящее время мы используем Unity 2022.3.5f1, и рекомендуется использовать ту же версию, чтобы избежать несовместимости.

Настройка единства

Единственная настройка единства, необходимая для правильных функционирования MAFI.

1. Скачать и установить Unity 2022.3.5f1 от https://unity3d.com/unity/qa/lts-releases.
2. Найдите испытательную сцену в src/ExampleMod.Unity . Еще не открывайте.
3. Создайте ссылку на каталог, называемую UnityRootSymlink в srcExampleMod.UnityLibrary , которая указывает на папку установки Unity (например, C:Program FilesUnityHubEditor2022.3.5f1 ). Это может быть сделано, вызывая команду mklink /D <target> <srouce> в окне консоли с привилегиями администратора. Например: mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" . Когда вы перемещаетесь в UnityRootSymlink вы должны увидеть в нем один каталог Editor .
4. Создайте жесткие связи для необходимых DLL из вашей установки Steam, запустив пакетный файл src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat . Вам нужно будет запустить его в рамках привилегий администратора (щелкнуть правой кнопкой мыши, запустить как администратор).
   • Хорошая практика - посмотреть на любой код, который вы используете под привилегиями администратора, поэтому не стесняйтесь сначала проверять пакетный файл.
   • В качестве альтернативы, вы также можете скопировать рассматриваемый DLL в этот каталог, но жесткая ссылка лучше, поскольку любое обновление исходных файлов будет распространяться.
5. Откройте тестовую сцену из src/ExampleMod.Unity/Assets/ExampleModScene.unity в редакторе Unity. Это можно сделать через Unity Hub, выбрав Open project from disk на вкладке Projects . Убедитесь, что вы выбираете правильную версию Unity, если у вас установлено несколько.
6. Убедитесь, что вы можете увидеть MaFi в верхнем меню в редакторе Unity. Если нет, связанные DLL не были должным образом загружены, и вы не сможете создавать активы.
7. Откройте ExampleModScene , дважды щелкните на панели Proejct (он находится под каталогом Assets ).
8. (Необязательно) Мы также рекомендуем изменить следующие настройки в редакторе Unity ( Edit -> Preferences ).
   • External tools -> External script editor -> Open by file extension . Это прекратит восстановление файлов проекта и размещает абсолютные пути вместо относительных.
   • General -> Disable Editor Analytics (если вы можете и хотите).

Создание активов иконы

Следующие шаги описывают, как упаковать значки, например, для новых продуктов.

1. Мы рекомендуем организовать активы в каталогах. В каталоге Assets Create <mod name>/<icons categor> каталог, в нашем случае, который является ExampleMod/ProductIcons .
2. Импортируйте изображения в виде файлов PNG или JPG в недавно созданный каталог.
3. Настройте вновь импортированные текстуры, чтобы иметь тип Sprite (2D and UI) и примените изменение.
4. Назначьте недавно импортируемые текстуры любому пакету активов из раскрывающегося меню в нижней части вкладки Inspector. Вы можете создать новый пакет под названием asdf или выбрать любой существующий.
5. Чтобы использовать значок в вашем моде (например, в качестве значка продукта), просто щелкните правой кнопкой мыши на текстуре и выберите Copy Path . Этот путь может быть использован для загрузки вашего Prefab в игру.
6. Следуйте шагам под пакетами упаковочных активов, чтобы упаковать созданные активы.

Примечание. В отличие от 3D -моделей, текстуры не должны создавать prefab .

Создание 3D -модельного актива

Следующие шаги описывают, как создать шаблон трехмерной модели, который очень полезны для создания 3D -моделей зданий.

1. Определите объект макета в вашем моде с желаемой макетой, указанной с использованием ASCII (см. ExampleMachineData.cs ).
2. Установите Prefab Path to "TODO" так как у нас еще нет сбора.
3. Скомпилируйте и разверните мод.
4. Запуск игры с недавно созданной машиной и запустить консольную команду generate_layout_entity_mesh_template с последующим идентификатором объекта. Это генерирует файл OBJ в %APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates , который представляет 3D -ограничивающую коробку с макетом вашего нового объекта с точными местоположениями порта.
5. Если у вас нет 3D -модели, загрузите недавно созданную модель шаблона в 3D -редактор по вашему выбору и создайте 3D -модель, которая ее подходит. Если у вас уже есть 3D -модель, вы можете сравнить ее с сгенерированным шаблоном и соответствующим образом отредактировать макет ASCII.
6. Когда 3D -модель завершена, экспортируйте FBX или OBJ и выполните следующие шаги.

Следующие шаги описывают, как упаковать 3D -модель.

1. Мы рекомендуем организовать активы в каталогах. В справочнике Assets Create <mod name>/<model name> каталог, в нашем случае, который является ExampleMod/ExampleModel .
2. Импортируйте файлы 3D модели (OBJ, FBX и т. Д.) И текстуры (PNG, JPG и т. Д.) В каталог модели. Вы можете просто использовать Drag & Drop. Создание отдельной папки для каждого актива рекомендуется.
3. Перетащите 3D -модель из Project Pane на сцену Unity. Сбросьте его положение и вращение на все нулы с помощью инспектора (вы можете использовать меню «Три точки» рядом с преобразованием) и заставить его выглядеть так, как вы хотите (добавьте материалы и т. Д.). Примечание: важно, чтобы ваш актив имел нулевое положение и вращение. Если вам нужно изменить его, измените 3D -модель или сделайте дочерний объект, который можно перемещать.
4. Создайте Prefab, перетаскивая объект Root и бросив его на панель Project. Это сделает новый файл .prefab . В нашем примере мы создали Prefab в каталоге <mod name> .
5. Назначьте недавно созданный Prefab любому пакету активов из раскрывающегося меню в нижней части вкладки Inspector. Вы можете создать новый временный пакет, вызванный asdf или выбрать любой существующий.
6. Чтобы использовать Prefabs в вашем моде, просто щелкните правой кнопкой мыши любой Prefab и выберите Copy Path . Этот путь может быть использован для загрузки вашего Prefab в игру.
7. Следуйте шагам под пакетами упаковочных активов, чтобы упаковать созданные активы.

Упаковочные активы

Как только ваши активы будут готовы, следуйте этим шагам, чтобы упаковать их с вашим модом. Моды опубликованы в каталоге с тем же именем, что и ваш мод DLL, в нашем случае у нас есть ExampleMod/ExampleMod.dll . Теперь мы можем добавить пакеты активов в тот же каталог.

1. Убедитесь, что каждый в единстве сохраняется (используйте Ctrl+S ).
2. Стройте пакеты активов, щелкнув правой кнопкой мыши в любом месте панели проекта (в любом файле или в пустой области) и выберите [MaFi] Build asset bundles . После того, как Unity будет выполнена обработка, файлы пакета активов можно найти в каталоге src/ExampleMod.Unity/AssetBundles .
3. Скопируйте содержимое папки src/ExampleMod.Unity/AssetBundles в папку AssetBundles рядом с MOD DLL, например %APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles .
4. (Необязательно) Если вы хотите сделать его аккуратным, вам действительно нужны только пучки актива (файлы в формате YourPrefabName_xxxx , без расширения) и файл mafi_bundles.manifest . Все остальные файлы .manifest могут быть удалены, а также файл AssetBundles .

Если вы внесете какие -либо изменения в своих префабах, просто восстановите пакеты активов и копируйте, используйте новые файлы из каталога AssetBundles .