ModResources

From The Colonists
Jump to navigation Jump to search

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

JSON

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

Icon

image file naming convention: resource_200.png
image file should be 128x128 pixel size with transparent background
Example file: Logs

3D Models

Github3DModels
See ModsUnityAssetBundles for general information.

Collider

For resource selection, a collider should be added and placed on Layer 9 (Content) and sized appropriately
A typical size collider would be a ~50x50x50 cube centered at X=0,Y=25,Z=0
See Examples: ExampleResourceCollider and ExampleResourceColliderLayer

Model Size

A tile is 100 x 100, and 4 resources may be stored side-by-side in a tile.
Because some buildings also use slight offsets to prevent the resource model from showing through walls, most resources are in the range of 35 x 35 to 40 x 40.

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 globalStorageUISpec 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.