ModResources: Difference between revisions

From The Colonists
Jump to navigation Jump to search
No edit summary
Line 14: Line 14:


Resource entries in '''resources.json''' will add or replace the base codex resources. To disable a base codex resource, change the 'isAvailable' property to false.
Resource entries in '''resources.json''' will add or replace the base codex resources. To disable a base codex resource, change the 'isAvailable' property to false.
==Base Codex File==
Generate default files using the button in the Mod Manager window.


=Resource Spec=
=Resource Spec=

Revision as of 19:16, 18 August 2021

Mod Resources Translation.csv

List of fields used in translation.csv for Resources

Resources Translation
placeholder for now - note common fields used in translation.csv for Resources
Should this section be in each individual mod item type's page OR a separate translation.csv [age that lists value/tables for each mod item type - and link to that mod item type??


Mod Resources

JSON

Allows you to change, remove, and create resources available in the game.

Resource entries in resources.json will add or replace the base codex resources. To disable a base codex resource, change the 'isAvailable' property to false.

Resource Spec

JSON fields

Field Description Example Notes
typeId Resource Unique ID 2 (Logs) For customIDs us a value between 200-250
category Resource Category 1 See ModCat in Resource
isAvailable Available In Game true set to false to remove from game

Assets

Icon

image file naming convention: resource_200.png
Example file: Logs

3D Models

Github3DModels

New Resources

When creating a new resource there is an extra step to get it to appear in all the right UI locations.

To appear in the resource panels (bottom left) amend the resourceCategoriesDict value for it in ui.json.

Notes

Please note that in the codex or codebase "resources" are sometimes referred to as "items". Consider these terms interchangeable.