ModResources: Difference between revisions

From The Colonists
Jump to navigation Jump to search
creation
 
creation
Line 2: Line 2:
=JSON=
=JSON=


Allows you to change, remove and create resources available in the game.
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 entries in '''resources.json''' will add or replace the base codex resources. To disable a base codex resource, change the 'isAvailable' property to false.
Line 20: Line 20:
| typeId
| typeId
| Resource Unique ID
| Resource Unique ID
| 2 [[Logs]]
| 2 ([[Logs]])
| For customIDs us a value between 200-250
| For customIDs us a value between 200-250
|-
|-
Line 33: Line 33:
===Icon===
===Icon===


**resource_200.png**
image file naming convention: ''resource_200.png''
 
{**200**} : resource ID


===3D Models===
===3D Models===


[https://github.com/codebyfire/mod-content-creator](https://github.com/codebyfire/mod-content-creator)
[https://github.com/codebyfire/mod-content-creator Github3DModels]


==New Resources==
==New Resources==
Line 45: Line 43:
When creating a new resource there is an extra step to get it to appear in all the right UI locations.
When creating a new resource there is an extra step to get it to appear in all the right UI locations.


1. To appear in the resource panels (bottom left) you need to amend [resourceCategoriesDict](https://www.notion.so/resourceCategoriesDict-21a03367d7c549e59a24be17b02ff32e) in **ui.json**.  
To appear in the resource panels (bottom left) amend the ''resourceCategoriesDict'' value for it in '''ui.json'''.  


==Notes
==Notes==


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

Revision as of 19:50, 14 April 2021

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.