mechanistry / timberborn-modding

Timberborn official modding tools and examples.
https://github.com/mechanistry/timberborn-modding
MIT License
38 stars 8 forks source link

Make OverwritesExample work without Unity #9

Open pzich opened 3 months ago

pzich commented 3 months ago

Currently if you take OverwritesExample and drop it in your Mods folder, it will not work. This is because it's designed to be built with Unity (which moves the contents from the Data dir into the root of the mod folder).

However, the README states:

You can modify and extend many aspects of the game without using code, Unity, or other mods by simply placing a .json file in the correct folder.

I think it would be good if this (or another example) worked "out of the box" without using code or Unity, as described. Or if not, make a clear note in the readme that this path needs to be different.

One thing that could also help is including the mod dir in the example paths shown after that. As an example, the translations section refers to the paths like MyFirstMod/Localizations/enUS_MyFirstMod.csv while specifications just says Specifications/Needs/NeedSpecification.Beaver.Hunger.json

Changing this to something like MyFirstMod /Specifications/Needs/NeedSpecification.Beaver.Hunger.json might help clarify where these need to go.