Captain of industry modding

Capitão da Modding da Indústria

Bem -vindo ao recurso oficial de modificação para o capitão do jogo da indústria.

Status do suporte de modding

A AI está atualmente disponível no Steam e está em fase de acesso antecipada. Embora o modding seja possível, ainda não é oficialmente apoiado. Estamos trabalhando continuamente para melhorar o suporte e a documentação da modificação.

Perguntas, questões

Observe que o suporte ao MOD é experimental e as APIs podem ter mudanças de quebra. Se você estiver com problemas, sempre examine os logs no %APPDATA%/Captain of Industry/Logs , eles contêm muitas informações úteis. Se você quiser discutir tópicos de modificação com a comunidade e os desenvolvedores, visite nosso canal Discord #Modding-dev-general (você precisará se atribuir uma função Mod creation no canal #pick-your-roles-here ). Você também pode registrar problemas aqui no Github, mas o tempo de resposta de nossa equipe pode ser adiado.

Pré -requisitos

Para começar a Modding COI, você precisará:

1. Capitão da indústria no Steam e tenha o jogo instalado.
2. Tem .NET Framework 4.7.1 instalado.
3. (Opcional) possui a unidade 2022.3.5f1 instalada (necessária apenas para criação de ativos).

Começando

1. Localize os arquivos do jogo COI por meio do clique com o botão direito do mouse no título do jogo no Steam Client -> Properties... -> Local Files -> Browse .
2. Copie o caminho raiz do jogo para a sua área de transferência (por exemplo C:/Steam/steamapps/common/Captain of Industry ).
3. Crie uma nova variável ambiental chamada COI_ROOT e defina seu valor no caminho da raiz do jogo copiado acima. No Windows, use a útil ferramenta Edit environmental variables , basta abrir o menu Iniciar e digitar Edit env e você deve vê -lo.
4. Fork/Baixe este repo.
5. Compile o ExampleMod na configuração Release localizada em src/ExampleMod/ExampleMod.sln . Recomendamos usar o Visual Studio, mas sinta -se à vontade para usar outras ferramentas, como o comando dotnet build Console. No Visual Studio, você deve ver todos os conjuntos dependentes vinculados corretamente. Caso contrário, e você está vendo muitos erros, verifique sua variável ambiental COI_ROOT , tente reiniciar.
6. Localize o ExampleMod.dll resultante em /bin/Release/net471 .
7. Encontre sua pasta de arquivos de dados COI (onde estão salva ou capturas de tela). Por padrão, está em %APPDATA%/Captain of Industry .
8. Abra ou crie Mods de diretório. Dentro dele, crie um novo diretório que tenha o mesmo nome que o seu mod dll, no nosso caso, é ExampleMod . Copie o ExampleMod.dll compilado, para que esteja no %APPDATA%/Captain of Industry/Mods/ExampleMod/ExampleMod.dll . Observe que o nome do diretório e o nome da DLL devem corresponder.
9. Inicie o jogo e, em configurações Miscellaneous , ative o suporte ao mod e reinicie o jogo para que a configuração entre em vigor.
10. Inicie um novo jogo e observe que o ExampleMod é carregado localizando um novo nó na árvore de pesquisa (aberto usando a chave G ). Em caso de erros, examine os registros no %APPDATA%/Captain of Industry/Logs .
11. Parabéns, agora você está executando seu mod no Capitão da Indústria!

Criação de ativos

Ativos como ícones ou modelos 3D podem ser criados usando o editor de unidade. Atualmente, usamos o Unity 2022.3.5F1 e é recomendável usar a mesma versão para evitar incompatibilidades.

Configuração da unidade

Configuração única de unidade necessária para que as ferramentas MAFI funcionem corretamente.

1. Faça o download e instale o Unity 2022.3.5f1 em https://unity3d.com/unity/qa/lts-releases.
2. Localize a cena do teste em src/ExampleMod.Unity . Não abra ainda.
3. Crie um link de diretório chamado UnityRootSymlink na srcExampleMod.UnityLibrary que aponta para a pasta de instalação da unidade (por exemplo, C:Program FilesUnityHubEditor2022.3.5f1 ). Isso pode ser feito invocando o comando mklink /D <target> <srouce> na janela do console com privilégios de administrador. Por exemplo: mklink /D "C:CaptainOfIndustryModdingsrcExampleMod.UnityLibraryUnityRootSymlink" "C:Program FilesUnity" . Ao navegar até o UnityRootSymlink você verá um único diretório Editor nele.
4. Crie links duros para as DLLs necessárias a partir da sua instalação de vapor executando o arquivo src/ExampleMod.Unity/Assets/DLLs/create_dll_hardlinks.bat . Você precisará executá-lo em privilégios de administrador (clique com o botão direito do mouse, execute como administrador).
   • É uma boa prática analisar qualquer código que você esteja executando em privilégios de administrador; portanto, sinta -se à vontade para inspecionar o arquivo em lote primeiro.
   • Como alternativa, você também pode copiar as DLLs em questão para este diretório, mas o hard link é melhor, pois qualquer atualização dos arquivos originais se propaga.
5. Abra o cenário de teste de src/ExampleMod.Unity/Assets/ExampleModScene.unity in the Unity Editor. Isso pode ser feito via Unity Hub selecionando Open project from disk na guia Projects . Certifique -se de selecionar a versão correta da unidade se tiver várias instalações.
6. Verifique se você pode ver MaFi no menu superior do editor de unidades. Caso contrário, as DLLs vinculadas não foram carregadas adequadamente e você não poderá criar ativos.
7. Abra o ExampleModScene clicando duas vezes no painel Proejct (está no diretório Assets ).
8. (Opcional) Recomendamos alterar as seguintes configurações no editor de unidades ( Edit -> Preferences ).
   • External tools -> External script editor -> Open by file extension . Isso parará de regenerar os arquivos do projeto e colocar caminhos absolutos em vez de parente.
   • General -> Disable Editor Analytics (se você puder e deseja).

Criação de ativos de ícone

As etapas a seguir descrevem como empacotar ícones, por exemplo, para novos produtos.

1. Recomendamos organizar ativos em diretórios. No diretório de Assets , crie o diretório <mod name>/<icons categor> , no nosso caso, que é ExampleMod/ProductIcons .
2. Importar imagens como arquivos PNG ou JPG para o diretório recém -criado.
3. Configure texturas recentemente importadas para ter o tipo Sprite (2D and UI) e aplique a alteração.
4. Atribua as texturas recentemente importadas a qualquer pacote de ativos do menu suspenso na parte inferior da guia Inspetor. Você pode criar um novo pacote chamado asdf ou escolher qualquer um existente.
5. Para usar um ícone no seu mod (por exemplo, como um ícone do produto), basta clicar com o botão direito do mouse em uma textura e selecione Copy Path . Esse caminho pode ser usado para carregar seu pré -fabricação no jogo.
6. Siga as etapas sob os pacotes de ativos de embalagem para empacotar os ativos criados.

NOTA: Ao contrário dos modelos 3D, as texturas não precisam criar um prefab .

Criação de ativo do modelo 3D

As etapas seguintes descrevem como criar um modelo de modelo 3D que é muito benefício na criação de modelos 3D de edifícios.

1. Defina uma entidade de layout em seu mod com o layout desejado especificado usando ASCII (consulte ExampleMachineData.cs ).
2. Defina o caminho pré -fabricado para "TODO" já que ainda não temos um pré -fabricador.
3. Compilar e implantar o mod.
4. Inicie o jogo com a máquina recém -criada e execute o comando do console generate_layout_entity_mesh_template seguido pelo seu ID da entidade. Isso gerará um arquivo OBJ em %APPDATA%/Captain of Industry/Misc/GeneratedMeshTemplates , que representa uma caixa limite 3D de layout de sua nova entidade com locais exatos da porta.
5. Se você não possui um modelo 3D, carregue o modelo de modelo recém -criado em um editor 3D de sua escolha e crie o modelo 3D que o encaixa. Se você já possui um modelo 3D, pode compará -lo com o modelo gerado e editar o layout ASCII de acordo.
6. Quando o modelo 3D estiver concluído, exporte FBX ou OBJ e siga as próximas etapas.

As etapas seguintes descrevem como empacotar um modelo 3D.

1. Recomendamos organizar ativos em diretórios. No diretório de Assets , crie <mod name>/<model name> diretório, no nosso caso, que é ExampleMod/ExampleModel .
2. Importar arquivos de modelo 3D (OBJ, FBX, etc.) e texturas (PNG, JPG, etc) para o diretório de modelos. Você pode simplesmente usar Drag & Drop. Criar uma pasta separada para cada ativo é recomendado.
3. Arraste o modelo 3D do painel do projeto para a cena da unidade. Redefina sua posição e rotação para todos os zeros usando o Inspetor (você pode usar o menu de três pontos ao lado para se transformar) e faça com que pareça o que quiser (adicione materiais etc.). Nota: É importante que seu ativo tenha posição zero e rotação. Se você precisar reposicioná -lo, altere o modelo 3D ou faça um objeto infantil que possa ser movido.
4. Crie um pré -fabricado arrastando o objeto raiz e soltando -o para o painel do projeto. Isso fará um novo arquivo .prefab . Em nosso exemplo, criamos o prefab no diretório <mod name> .
5. Atribua o recém-criado Prefab a qualquer pacote de ativos do menu suspenso na parte inferior da guia Inspetor. Você pode criar um novo pacote temporário chamado asdf ou escolher qualquer um existente.
6. Para usar os pré-fabricados no seu mod, basta clicar com o botão direito do mouse em qualquer pré-fabricação e selecione Copy Path . Esse caminho pode ser usado para carregar seu pré -fabricação no jogo.
7. Siga as etapas sob os pacotes de ativos de embalagem para empacotar os ativos criados.

Pacotes de ativos de embalagem

Quando seus ativos estiverem prontos, siga estas etapas para empacotá -las com seu mod. Os mods são publicados em um diretório com o mesmo nome que o seu mod dll; no nosso caso, temos ExampleMod/ExampleMod.dll . Agora podemos adicionar pacotes de ativos ao mesmo diretório.

1. Certifique -se de que tudo na unidade seja salvo (use Ctrl+S ).
2. Crie pacotes de ativos clicando com o botão direito do mouse em qualquer lugar do painel do projeto (em qualquer arquivo ou área vazia) e selecione [MaFi] Build asset bundles . Após o processamento da unidade, os arquivos de pacote de ativos podem ser encontrados no diretório src/ExampleMod.Unity/AssetBundles .
3. Copie o conteúdo da src/ExampleMod.Unity/AssetBundles para a pasta AssetBundles ao lado da DLL MOD, por exemplo %APPDATA%/Captain of Industry/Mods/ExampleMod/AssetBundles .
4. (Opcional) Se você deseja deixá -lo limpo, você realmente só precisa dos pacotes de ativos (arquivos no formato YourPrefabName_xxxx , sem extensão) e o arquivo mafi_bundles.manifest . Todos os outros arquivos .manifest podem ser removidos, bem como o arquivo AssetBundles .

Se você fizer alguma alteração nos seus pré -fabricados, basta reconstruir os pacotes de ativos e a cópia, use os novos arquivos do diretório AssetBundles .