ModResources: Difference between revisions

From The Colonists
Jump to navigation Jump to search
creation
No edit summary
Line 1: Line 1:
'''Mod Resources Translation.csv'''
== List of fields used in translation.csv for Resources==
placeholder for now - note common fields used in translation.csv for Resources<br>
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??
{| class="wikitable sortable"
|-
! ExampleEntry !!  Description !!  In-Game Example
|-
| Item_200_Name
| Resource Name
| Tooltip when hover over resource
|-
| Item_200_Desc
| Short description of Resource
| Tooltip when hover over resource icon in a panel
|-
| Item_200_FullDesc
| Full description of Resource
| Shown in resource info panel
|-
| Item_2000_Past
| Resource past tense
| Info in a Building when produced/consumed?
|-
| Item_200_Present
| Resource present tense
| Info in a Building while producing?
|}
'''Mod Resources'''
'''Mod Resources'''
=JSON=
=JSON=

Revision as of 16:01, 16 August 2021

Mod Resources Translation.csv

List of fields used in translation.csv for Resources

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??

ExampleEntry Description In-Game Example
Item_200_Name Resource Name Tooltip when hover over resource
Item_200_Desc Short description of Resource Tooltip when hover over resource icon in a panel
Item_200_FullDesc Full description of Resource Shown in resource info panel
Item_2000_Past Resource past tense Info in a Building when produced/consumed?
Item_200_Present Resource present tense Info in a Building while producing?

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.

Base Codex File

Generate default files using the button in the Mod Manager window.

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

Assets

Icon

image file naming convention: resource_200.png

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.