Modding SawGod
SawGod keeps the game's data, text, graphics and maps in plain files: spreadsheets, PNGs and text you can
open in ordinary tools. A mod is a folder of replacement files, or the same folder zipped into a
.sgz file. .sgz files are just zipped resource packs. Each file in a mod changes
only what it lists, and you never need to touch the game itself.
The mod format may change in 1.x releases. Any change will be listed in the release notes.
Install a mod
Drop it in mods/
Put the folder or .sgz file in the mods/ folder inside the game's data
folder, then start the game. To remove it, take it out and restart.
- Windows and Linux: beside the game, next to
sawgod.toml. - macOS:
~/Library/Application Support/sawgod/sawgod/ - Android: mods live in the app's private storage, so they are not easy to install yet.
Several mods
Mods load in name order. When two mods change the same thing (the same table cell, line of text or file), the later one wins.
At startup the game lists each mod and what it changed. A mod it can't read, or a bad row, is reported and skipped; the game still starts.
To try a mod for one session only, start the game with sawgod --mod PATH.
Your first mod: cheap Potions
This mod makes a Potion cost 1 gold.
-
Make the folder
cheap-potions/ mod.toml name, version, author, description (optional) tables/ items.csv only the rows and columns you change
-
Describe it
mod.tomlname = "Cheap Potions" version = "1.0" author = "you" description = "Potions cost 1 gold"
-
Change the price
Item 0 is the Potion. Rows you leave out, and columns you don't give, keep their values.
tables/items.csvid,price 0,1
-
Try it
Put
cheap-potions/inmods/, start the game and visit a shop. To share it, zip the folder and rename the zip tocheap-potions.sgz.
What you can change
A mod mirrors the layout of the game's own resource packs.
| Put this in your mod | To change |
|---|---|
tables/*.csv | Game data: items, shops, monsters and their graphics, formations, encounters and their odds, maps, tilesets, meat. |
text/en.csv, text/ja.csv | Any line of text, by key: menus, battle messages, names, item descriptions, dialogue. |
gfx/*.png | WonderSwan Color graphics: tilesets, battle and scene art, the font. Indexed PNGs; keep each picture's size. |
gb/ | The Game Boy look: map tiles, sprites, font, monsters and title. |
maps/ | Field maps: layout, walkability and tile sets. |
scripts/, raw/, audio/ | Event scripts, sound and other data not decoded yet, byte for byte; keep the size. |
Every format is documented in the mod reference, with the full list of tables in the table reference.
Find what to change
Look inside the game's files
On first run SawGod builds wsc.sgz and gb.sgz in the data folder from
your ROM. Copy one somewhere else, rename the copy to .zip and open it to see every
table, text file and picture, with their IDs and file names.
Copy only what you change into your mod. Never edit the originals: the game rebuilds them, and your changes belong in a mod.
Translate
Text is keyed, so a translation is a text/en.csv with key,text rows.
Keep tokens such as {actor} and {amount}; you may reorder them to suit
the sentence.
The text guide covers tokens, line breaks, the fit check and the font.
Beyond files
Rules the tables can't express (how damage is worked out, what happens when a battle starts) change in code. SawGod's source exposes C++ hooks for game events and values; this needs a source build. See How it works for the big picture.