Difference between revisions of "Modding"

From Captain of Industry Wiki
Jump to: navigation, search
m (Minor addition about layouts)
(Smaller additions)
Line 3: Line 3:
Modding is an exciting endeavor! Hopefully this page can serve as a quick-start on how you can do it to!
Modding is an exciting endeavor! Hopefully this page can serve as a quick-start on how you can do it to!


Use `dotnet build /p:LangVersion=10.0` for building mod, as otherwise it'll throw errors about too new language features being used.
== Requirements ==


- .NET Framework - https://dotnet.microsoft.com/en-us/download/dotnet-framework/net462
== Quick Start ==
- Clone https://github.com/MaFi-Games/Captain-of-industry-modding into a directory (<code>https://github.com/MaFi-Games/Captain-of-industry-modding.git</code>)
- Navigate to the directory and into <code>src/ExampleMod</code>
- Run <code>dotnet build /p:LangVersion=10.0</code>
We're using <code>/p:LangVersion=10.0</code> for building mod, as otherwise it'll throw errors about too new language features being used.


== Layouts / EntityLayoutParams ==
== Layouts / EntityLayoutParams ==

Revision as of 16:47, 16 January 2023

PAGE IS WIP AND UNDER CONSTRUCTION!

Modding is an exciting endeavor! Hopefully this page can serve as a quick-start on how you can do it to!

Requirements

- .NET Framework - https://dotnet.microsoft.com/en-us/download/dotnet-framework/net462


Quick Start

- Clone https://github.com/MaFi-Games/Captain-of-industry-modding into a directory (https://github.com/MaFi-Games/Captain-of-industry-modding.git)

- Navigate to the directory and into src/ExampleMod

- Run dotnet build /p:LangVersion=10.0

We're using /p:LangVersion=10.0 for building mod, as otherwise it'll throw errors about too new language features being used.

Layouts / EntityLayoutParams

Layouts of structures such as machines or storages are based on a ASCII format passed as list of strings.

References / Samples

- https://github.com/MaFi-Games/Captain-of-industry-modding - Official quick-start template

- https://github.com/altmank/CaptainOfCheats - Example mod using a lot of functionality as a sort of cheat engine