Publishing
Put a mod in the registry: screenshots, the checker, a pull request, and a new version for every change.
The registry is the public repository steel-tide/mods: every mod is a folder under mods/<id>/, and the game and this site list what is there.
- Fork it and add your folder as
mods/<id>/; the folder name is the mod'sid. - Add at least one screenshot of the mod in play and name it under
screenshotsinmod.json: 4:3 (1600 × 1200 is a good size), at least 640 px wide, PNG, JPEG or WebP under 2 MB, up to eight of them. The game's mod list and the mod's page here show them; the first is the mod's card. A match with the mod's units on screen is the picture (the console'sgiveputs them there), cropped to 4:3. - Run
node tools/check.mjs mods/<id>. It prints every error the game would, checks the screenshots, and checks the folder against every other published mod: ids are global, so prefix a generic word with your mod's id (ironworks-bunker, notbunker). - Open a pull request. CI runs the same check; once merged, the index is rebuilt and the mod appears in the game's registry list and on the mods page, where its installs are counted.
- Bump
versionfor every change. The game offers the update to whoever has the mod.
A mod is published under the licence its manifest names (CC-BY-4.0 unless you say otherwise). Only ship art you have the right to.
Last edited