Getting Started

This set of documents is meant to get you up to speed with patch manager, getting you from nothing to your first patch.

It is highly recommended for you to read this in order if you are new to patching. :3

  • What is Patch Manager explains the model: patches change the game's JSON assets as they load, so you tweak data instead of editing the game.

  • How the game's content is organized is the small vocabulary (assets, addresses, labels) the rest of the docs assume, plus how to find a real asset id.

  • Setting up your editor installs the Patch Manager Lua extension so you get autocomplete and inline docs for the whole PM and J surface.

  • Your first patch walks through a small, real patch line by line.

  • File layout and discovery explains where patch files go, how the game finds them, and what ModId and Location are.

  • Shipping patches covers packaging patches in a mod so other people can install them.