Mods: Difference between revisions
Jump to navigation
Jump to search
Stlnegril9 (talk | contribs) No edit summary |
Stlnegril9 (talk | contribs) No edit summary |
||
| Line 18: | Line 18: | ||
=Codex= | =Codex= | ||
==Base Codex File== | |||
Generate default files using the '''Export Base Codex''' button in the Mod Manager window. | |||
==[[ModAnimals|Animals]]== | ==Codex Objects== | ||
==[[ModBoats|Boats]]== | ===[[ModAnimals|Animals]]=== | ||
==[[ModBuildings|Buildings]]== | ===[[ModBoats|Boats]]=== | ||
==[[ModFlora|Flora]]== | ===[[ModBuildings|Buildings]]=== | ||
==[[ModMarket|Market]]== | ===[[ModFlora|Flora]]=== | ||
==[[ModNatural Resources|Natural Resources]]== | ===[[ModMarket|Market]]=== | ||
==[[ModProjectiles|Projectiles]]== | ===[[ModNatural Resources|Natural Resources]]=== | ||
==[[ModResources|Resources]]== | ===[[ModProjectiles|Projectiles]]=== | ||
==[[ModStructures|Structures]]== | ===[[ModResources|Resources]]=== | ||
==[[ModTechs|Techs]]== | ===[[ModStructures|Structures]]=== | ||
==[[ModTrains|Trains]]== | ===[[ModTechs|Techs]]=== | ||
==[[ModUnits|Units]]== | ===[[ModTrains|Trains]]=== | ||
===[[ModUnits|Units]]=== | |||
=Interface= | =Interface= | ||
==[[ModUI]]== | ==[[ModUI]]== | ||
==JSON fields== | ==JSON fields== | ||
{| class="wikitable sortable" style="text-align: center" | {| class="wikitable sortable" style="text-align: center" | ||
| Line 50: | Line 47: | ||
|- | |- | ||
| constructionGridBuildingIds | | constructionGridBuildingIds | ||
| Defines order of buildings in the building selection (bottom right) | | Defines order of [[Building|buildings]] in the building selection (bottom right) | ||
|- | |- | ||
| resourceCategoriesDict | | resourceCategoriesDict | ||
| Defines categorisation and order of resources show in the bottom left | | Defines categorisation and order of [[Resource|resources]] show in the bottom left | ||
|- | |- | ||
| techCategoryOrderIds | | techCategoryOrderIds | ||
| Defines order of research categories on research panel | | Defines order of [[Research|research]] categories on research panel | ||
|- | |- | ||
|} | |} | ||
Revision as of 19:20, 18 August 2021
Mods are in development! This section is a work in progress!
Setup
Creating a mod
- If it doesn't already exist, create a Mods folder inside %userprofile%\appdata\LocalLow\Codebyfire Ltd\The Colonists\
- Create a folder for your mod inside the Mods folder, e.g. codebyfireTestMod
- Everything then goes inside codebyfireTestMod. You can use subfolders to organise content or keep it all in the main directory, the mod loader in the game will just look at the name of the file to determine what it is.
Enabling a mod
- When you run the game, open the Mod Manager window and you should see an entry for codebyfireTestMod as well as any other folders in the Mods directory.
- To enable a mod, tick the entry in the list. At this point any DLLs will be initialised.
- Create a sandbox game and the game will process all other content in your mod, i.e. json files, images etc.
- You can update your mod and reload the codex mid-game using the button in the top left info panel.
Some things may go wrong when reloading the codex mid-game, depending on the changes you make! For example, removing a building or resource may not go down well.
Codex
Base Codex File
Generate default files using the Export Base Codex button in the Mod Manager window.
Codex Objects
Interface
JSON fields
| Name | Description |
|---|---|
| constructionGridBuildingIds | Defines order of buildings in the building selection (bottom right) |
| resourceCategoriesDict | Defines categorisation and order of resources show in the bottom left |
| techCategoryOrderIds | Defines order of research categories on research panel |