Changing anything
Files over ours
Any file under a mod's resources/ folder stands in for what the game loads from Assets/Resources/ at the same path. Nothing in mod.json is needed for it. Format 4.
my_mod/
resources/
Camp/Ring.png stands in for Assets/Resources/Camp/Ring
Barks/en/peasants.json merged into our barks (Words and barks)| file | stands in for |
|---|---|
.png | a picture or a sprite |
.wav, .ogg, .mp3 | a sound |
.json, .txt, .bytes | a text or data file |
The example mod Examples/resources puts a sooty ring of stones round every campfire with one picture, resources/Camp/Ring.png.
Pictures and sprites
A picture keeps ours' import: its filter, wrap and colour space.
- Ours a whole sprite: yours may be any size. Its pivot sits at the same part of it (the middle, the feet), with the same pixels per unit.
- Ours cut from a sheet: yours is cut at the same places, counted from the top left. So a sheet may grow down and to the right, but not shrink. One too small is told, and ours is kept.
- A sprite keeps ours' pixels per unit, pivot and border.
Folders read whole
A folder the game reads whole (the hair sheets, a voice's takes, a sound set) also gets any new files a mod adds to it. Each of the mod's files takes the place of ours at its path; new ones come after ours.
Which file wins
- The later mod, by id, wins where two switched-on mods have the same file.
- A file that can't be read is told on the Mods page (
resources/Camp/Ring.png: is not a PNG), and ours is used. - A file no load can use (a
.psd), or two files of one kind at one path, is told as the mod loads.
What isn't replaced this way
Shaders, fonts, the interface's style sheets, the content catalog, the network's prefab table and the RP data files. RP rows are changed with patches (rp/...).
Art the game keeps once it has read it (a campfire's pictures, a saber's sounds) stays as first loaded until the game starts again. Pictures read as a scene or a sheet loads change when it loads again.
On the bench
The Files over ours group lists the mod's files under resources/, each saying whether it stands in for one of ours or is new, and each language the mod gives words for.
- + offers A copy of one of ours: a picker over the game's files by kind and folder. A picture is drawn out as a PNG, a sound as a WAV, a text as it is, into
resources/<path>. - A picture opens on its own pixel canvas, with ours beside it and what keeps the game cutting it the same.
- A sound plays beside ours, with its length, channels and rate; one saved over in any sound program comes in by itself.
- A text is written beside ours, which is read-only.
- Delete the file puts ours back, after asking.

Modding