Modding
Discord Wishlist on Steam

Getting started

The ModKit

Every Windows build of the game has a ModKit folder beside the exe, made from that build's own content. Steam ships it with the game, so it always matches the game you have. The Mods page's Modding tools opens it.

What is in it

For every weapon and every piece of ours, in Weapons/ and Armour/:

filewhat it is
<Name>.pngthe picture to start from. A piece drawn from several sheets has its others as <Name>.<part>.png, laid out exactly as a mod's must be
<Name>.jsonan entry for mod.json already filled in from it: its grip, its edge, its main numbers
<Name>.fields.jsonevery number it has, by name, to look names up in

And beside them:

filewhat it is
modkit.jsonformat, the modding format the game reads, the game's version and the day the kit was made
nodes.jsonevery node a graph can use, with its pins, their kinds, where it runs and its tips
Nodes.mdthe same as a reference to read: the node book first, then the library, then game code
addresses.jsonevery thing, item, quest and settings asset of ours a patch can name
RP/the RP data files as the game reads them; rp/ patches name their rows by id
Example/, Examples/the example mods: weapons and armour, patches, graphs, files over ours, maps, a library and a mod built on it
Templates/the templates the bench starts a mod from
Modding.mdthe modding guide in one file
Docs/these docs, to read without the internet: open Docs/index.html. Every page is beside it as Markdown too, and Docs/llms-full.txt holds them all in one file
schemas/JSON Schemas of a mod's files: mod.schema.json, patches.schema.json, graph.schema.json, map.schema.json, brain.schema.json

Making it yourself

  • In the Unity editor: Tools > Black Autumn > Mods > Export ModKit writes it into the project's ModKit folder.
  • The game started with -modkit writes it into the player's data folder.

The examples

Copy an example's folder into a Mods folder and switch it on to try it. Each has a README saying what it shows.

exampleshows
Examplea new weapon and a new piece of armour
Examples/patchesevery kind of address: a thing, an item, a quest with its dialogue, settings assets, RP rows, a map object and things placed
Examples/graphsthe bells ringing at Prime, and a town crier sending news to every player
Examples/resourcesa sooty campfire ring over ours, a Czech menu, and barks for timid peasants
Examples/mapsHrádok, an arena map over the ford, and outworks before Šášov for the siege
Examples/librarya mod made only of functions, for other mods to use
Examples/uses-librarya mod that requires the library and calls its functions