Mods: Difference between revisions
Stlnegril9 (talk | contribs) No edit summary |
Stlnegril9 (talk | contribs) No edit summary |
||
| Line 62: | Line 62: | ||
==[[buildingFloorCoordDict|Building Footprint]]== | ==[[buildingFloorCoordDict|Building Footprint]]== | ||
==[[structureFloorCoordDict|Structures Footprint]]== | ==[[structureFloorCoordDict|Structures Footprint]]== | ||
AnimalField, PlantableField, and TreeField footprint can be controlled in '''render.json''' | |||
==[[treeFieldRenderSpecDict|Tree Fields | ==[[treeFieldRenderSpecDict|Tree Fields Rendering]]== | ||
==[[plantableFieldRenderSpecDict|Plantable Fields | ==[[plantableFieldRenderSpecDict|Plantable Fields Rendering]]== | ||
Revision as of 20:12, 17 January 2022
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
Scripting (C#)
Text/Localisation
Building and Structure footprint rendering
The render.json file can be used to change the building, structure, and track footprint shown when they are placed.
The file floor_buildings.png contains the graphics for the current buildings, structures, and tracks.
The file floor_base.png can be used to modify buildings, plots, and tracks with ID under 200 (existing)
The file floor_extra.png can be used to modify buildings, plots, and tracks with ID over 200 (new)
These files are size: 2048 x 2048 pixels
Building footprints are a 64 x 64 tiled grid with 0,0 being in the bottom left.
Structure footprints are a 68 x 68 tiled grid with 0,0 being in the bottom left, with a 2 pixel "bleed" border.
AnimalField, PlantableField, and TreeField footprint can be controlled in render.json