Captain of industry modding

Capitán de modificación de la industria

Bienvenido al recurso de modificación oficial para el Capitán del Juego de la Industria.

Estado del soporte de modificación

COI está actualmente disponible en Steam y está en la etapa de acceso temprano. Si bien el modding es posible, aún no se compatece oficialmente. Estamos trabajando continuamente para mejorar el soporte y la documentación de modificación.

Preguntas, problemas

Tenga en cuenta que el soporte del MOD es experimental y las API podrían tener cambios rotos. Si tiene problemas, siempre examine los registros en el directorio %APPDATA%/Captain of Industry/Logs , contienen mucha información útil. Si desea discutir temas de modificación con la comunidad y los desarrolladores, visite nuestro canal Discord #Modding-Dev-General (necesitará asignarse un papel Mod creation en #pick-your-roles-here Channel). También puede presentar problemas aquí en GitHub, pero el tiempo de respuesta de nuestro equipo podría retrasarse.

Requisitos previos

Para comenzar a modificar COI, deberá:

1. Capitán de la industria en Steam y tenga el juego instalado.
2. Tener .NET Framework 4.7.1 instalado.
3. (Opcional) tienen Unity 2022.3.5f1 instalado (necesario solo para la creación de activos).

Empezando

1. Localice los archivos del juego COI mediante el clic derecho en el título del juego en el cliente Steam -> Properties... -> Local Files -> Browse .
2. Copie la ruta de la raíz del juego a su portapapeles (por ejemplo, C:/Steam/steamapps/common/Captain of Industry ).
3. Cree una nueva variable ambiental llamada COI_ROOT y establezca su valor en la ruta de la raíz del juego copiada anteriormente. En Windows, use la práctica herramienta Edit environmental variables , simplemente abra el menú de inicio y escriba Edit env y debería verlo.
4. Hornilla/descarga este repositorio.
5. Compile el ExampleMod en la configuración Release ubicada en src/ExampleMod/ExampleMod.sln . Recomendamos usar Visual Studio, pero no dude en usar cualquier otra herramienta, como el comando dotnet build Console. En Visual Studio, debería ver todos los conjuntos dependientes vinculados correctamente. Si no es así, y está viendo muchos errores, verifique su variable ambiental COI_ROOT , intente reiniciar.
6. Localice el ExampleMod.dll in /bin/Release/net471 .
7. Encuentre su carpeta de archivos de datos de COI (donde se guarda o las capturas de pantalla). Por defecto, es en %APPDATA%/Captain of Industry .
8. Abra o cree Mods de directorio. Dentro de él, cree un nuevo directorio que tenga el mismo nombre que su Mod DLL, en nuestro caso, es ExampleMod . Copie el ExampleMod.dll compilado allí, de modo que esté en %APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll . Tenga en cuenta que el nombre del directorio y el nombre de DLL deben coincidir.
9. Inicie el juego y en la configuración Miscellaneous habilite el soporte del mod y reinicie el juego para que la configuración entre en vigencia.
10. Inicie un nuevo juego y observe que el ExampleMod se carga localizando un nuevo nodo en el árbol de investigación (abierto con la tecla G ). En el caso de cualquier error, examine los registros en el directorio %APPDATA%/Captain of Industry/Logs .
11. ¡Felicitaciones, ahora estás ejecutando tu mod en Capitán de la industria!

Creación de activos

Se pueden crear activos como iconos o modelos 3D utilizando el editor Unity. Actualmente usamos Unity 2022.3.5f1 y se recomienda usar la misma versión para evitar incompatibilidades.

Configuración de unidad

La configuración de la unidad única necesaria para las herramientas MAFI para funcionar correctamente.

1. Descargue e instale Unity 2022.3.5f1 desde https://unity3d.com/unity/qa/lts-releases.
2. Localice la escena de prueba en src/ExampleMod.Unity . No lo abras todavía.
3. Cree un enlace de directorio llamado UnityRootSymlink en srcExampleMod.UnityLibrary que apunta a la carpeta de instalación de Unity (p C:Program FilesUnityHubEditor2022.3.5f1 Esto se puede hacer invocando el comando mklink /D <target> <srouce> en la ventana de consola con priviligios administrativos. Por ejemplo: mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" . Cuando navegue al UnityRootSymlink debería ver un solo directorio Editor en él.
4. Cree enlaces duros para las DLL necesarias desde su instalación de Steam ejecutando el archivo src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat lotes. Deberá ejecutarlo bajo privilegios de administración (haga clic derecho, ejecute como administrador).
   • Es una buena práctica ver cualquier código que esté ejecutando bajo privilegios de administración, así que no dude en inspeccionar primero el archivo por lotes.
   • Alternativamente, también puede copiar las DLL en cuestión a este directorio, pero el enlace duro es mejor ya que cualquier actualización de los archivos originales se propagará.
5. Abra la escena de prueba de src/ExampleMod.Unity/Assets/ExampleModScene.unity en el editor Unity. Esto se puede hacer a través de Unity Hub seleccionando Open project from disk en la pestaña Projects . Asegúrese de seleccionar la versión de Unity correcta si tiene múltiples instalados.
6. Verifique que pueda ver MaFi en el menú superior en el editor Unity. Si no, las DLL vinculadas no se cargaron correctamente y no podrá crear activos.
7. Abra el ExampleModScene haciendo doble clic en él en el panel Proejct (está en el directorio Assets ).
8. (Opcional) También recomendamos cambiar la siguiente configuración en Unity Editor ( Edit -> Preferences ).
   • External tools -> External script editor -> Open by file extension . Esto dejará de regenerar archivos del proyecto y colocar rutas absolutas en lugar de relativa.
   • General -> Disable Editor Analytics (si puede y desea).

Creación de activos de icono

Los siguientes pasos describen cómo empacar iconos, por ejemplo, para nuevos productos.

1. Recomendamos organizar activos en directorios. Según el directorio Assets , cree <mod name>/<icons categor> Directorio, en nuestro caso que sea ExampleMod/ProductIcons .
2. Importar imágenes como archivos PNG o JPG al directorio recién creado.
3. Configure las texturas recién importadas para tener el tipo Sprite (2D and UI) y aplique el cambio.
4. Asigne las texturas recién importadas a cualquier paquete de activos desde el menú desplegable en la parte inferior de la pestaña Inspector. Puede crear un nuevo paquete llamado asdf o elegir cualquier uno existente.
5. Para usar un icono en su mod (por ejemplo como un icono de producto), simplemente haga clic derecho en una textura y seleccione Copy Path . Ese camino se puede usar para cargar su prefabricación en el juego.
6. Siga los pasos en los paquetes de activos de empaque para empaquetar los activos creados.

Nota: A diferencia de los modelos 3D, las texturas no necesitan crear una prefab creada.

Creación del activo del modelo 3D

Los siguientes pasos describen cómo crear una plantilla de modelo 3D que sea muy beneficiosa en la creación de modelos 3D de edificios.

1. Defina una entidad de diseño en su mod con el diseño deseado especificado usando ASCII (consulte ExampleMachineData.cs ).
2. Establezca la ruta prefabricada a "TODO" ya que todavía no tenemos prefabricado.
3. Compilar e implementar el mod.
4. Inicie el juego con el comando de consola recién creado y ejecute generate_layout_entity_mesh_template seguido de su ID de entidad. Esto generará un archivo OBJ en %APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates que representa un cuadro de diseño delimitador 3D de su nueva entidad con ubicaciones de puertos exactas.
5. Si no tiene un modelo 3D, cargue el modelo de plantilla recién creado a un editor 3D de su elección y cree un modelo 3D que se adapte a él. Si ya tiene un modelo 3D, puede compararlo con la plantilla generada y editar el diseño ASCII en consecuencia.
6. Cuando se completa el modelo 3D, exporte FBX u OBJ y siga los siguientes pasos.

Los siguientes pasos describen cómo empaquetar un modelo 3D.

1. Recomendamos organizar activos en directorios. Según el directorio Assets , cree <mod name>/<model name> directorio, en nuestro caso que es ExampleMod/ExampleModel .
2. Importar archivos de modelo 3D (OBJ, FBX, etc.) y texturas (PNG, JPG, etc.) al directorio de modelos. Simplemente puede usar arrastrar y soltar. Se recomienda crear una carpeta separada para cada activo.
3. Arrastre el modelo 3D del panel del proyecto a la escena de la unidad. Restablezca su posición y rotación a todos los ceros usando Inspector (puede usar el menú de tres puntos junto a la transformación) y hacer que se vea como desee (agregue materiales, etc.). Nota: Es importante que su activo tenga una posición y rotación cero. Si necesita reposicionarlo, cambie el modelo 3D o haga un objeto infantil que se pueda mover.
4. Cree una prefabricación arrastrando el objeto raíz y dejándolo al panel del proyecto. Esto hará un nuevo archivo .prefab . En nuestro ejemplo, creamos la prefabricación en el directorio <mod name> .
5. Asigne la prefabricación recién creada a cualquier paquete de activos desde el menú desplegable en la parte inferior de la pestaña Inspector. Puede crear un nuevo paquete temporal llamado asdf o elegir cualquier uno existente.
6. Para usar prefabricados en su mod, simplemente haga clic derecho en cualquier prefabricación y seleccione Copy Path . Ese camino se puede usar para cargar su prefabricación en el juego.
7. Siga los pasos en los paquetes de activos de empaque para empaquetar los activos creados.

Paquetes de activos de embalaje

Una vez que sus activos estén listos, siga estos pasos para empaquetarlos con su mod. Las modificaciones se publican en un directorio con el mismo nombre que su DLL MOD, en nuestro caso tenemos ExampleMod/ExampleMod.dll . Ahora podemos agregar paquetes de activos al mismo directorio.

1. Asegúrese de que todo en la unidad se guarde (use Ctrl+S ).
2. Construya paquetes de activos haciendo clic derecho en cualquier lugar del panel del proyecto (en cualquier archivo o área vacía) y seleccione [MaFi] Build asset bundles . Una vez que la Unidad se termina del procesamiento, los archivos de paquete de activos se pueden encontrar en el directorio src/ExampleMod.Unity/AssetBundles .
3. Copiar contenido de src/ExampleMod.Unity/AssetBundles a la carpeta AssetBundles junto a MOD DLL, por ejemplo %APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles .
4. (Opcional) Si desea que lo haga bien, realmente solo necesita los paquetes de activos (archivos en formato YourPrefabName_xxxx , sin extensión) y el archivo mafi_bundles.manifest . Todos los demás archivos .manifest podrían eliminarse, así como el archivo AssetBundles .

Si realiza algún cambio en sus prefabricados, simplemente reconstruya los paquetes de activos y copie use los nuevos archivos del directorio de AssetBundles .