Skip to content

๐Ÿงช Modding

This section covers everything about authoring mods and understanding how the modding ecosystem fits together โ€” from "I want to change one building cost" all the way to "I'm shipping a Pattern B overlay pak with cross-pak entity merging".

If you're new to Pagonia modding, start with First Modding Experiments for a guided edit. The pages below assume you've already got your local game data set up โ€” see Local Setup if you haven't yet.

Practice

Concept guides and reference docs for actually writing and shipping mods:

Page What it covers
โ›๏ธ Sandbox The local workshop layout under sandbox/ for writing your own mods. Three-step workflow (extract โ†’ patch โ†’ sandbox/out/), plus the sandbox-pack script to bundle the patched output into a .pak. Start here when you're ready to author.
โœ… Safe Edits What changes are low-risk vs. likely to break things. Read this before your first edit.
โš ๏ธ Modding Risk Map Specific high-risk areas: objectives, tech tree, unit attachments, rare components. Practical "be careful here" map.
๐Ÿšš Mod Distribution Patterns The three observed mod shapes: Pattern A (patched canonical pak), Pattern B (side-by-side overlay), Pattern C (user maps). Plus Meadowsong cross-pak entity merging.
๐Ÿ“„ Declarative Patch Format The mod.yaml schema, the ten patch operations, target resolution, optional metadata. The reference for hand-authoring patches.
โœจ Mod Tweaks User-adjustable mod values โ€” how an author declares them, a curator presets them in a collection, and a player configures them in the manager. The end-to-end map of the feature.
๐Ÿ’ฅ Patch Conflict Model What counts as a conflict between two mods, how the patcher detects it, the resolution model the manager surfaces.
๐Ÿ“š Mod Collections Curated mod lists, lockfiles, profiles, collection-vs-mod boundary, safety rules.
๐Ÿ—‚๏ธ Mod Catalogs Curated lists of mod-distribution repos the manager subscribes to and aggregates into one catalog browse view โ€” for users discovering mods and for publishers curating their own list.
๐Ÿท๏ธ Mod Tags Vocabulary The shared tag vocabulary used across mod.yaml, collections, catalogs, and repo indexes so users can find โ€” and tooling can filter โ€” mods.
๐Ÿ”— Patcher and Manager Architecture How the three tools (pagonia-patcher, pagonia-paker, pagonia-manager) compose, the JSON-schema + diagnostic-code contracts integrators consume.

Worked Examples

Step-by-step traces and small edits to learn by doing โ€” the fastest way to internalise the patterns above:

  • ๐Ÿ’ก Worked Examples index โ€” overview of the example library
  • Traces โ€” follow a value across files without editing anything (sawmill chain, full production chain, resource deposit to building, DLC production addition, map objective, artifact / treasure / shrine, unit attachments, tech tree unlock, tools-editor sediment)
  • Small Edits โ€” change a building construction cost, a recipe resource amount, a resource display name or icon, a unit recruitment cost, create a decoration variant
  • Patch Examples โ€” complete mod.yaml files for cheaper-sawmill, optional DLC patch set, resource icon patch, intentional conflict example
  • Collection Examples โ€” curated .collection.yaml manifests with lockfiles
  • Repo & Catalog Layouts โ€” full reference layouts to fork when publishing: sandbox templates, mod-repo layouts, a multi-mod repo example, a mod catalog example

Every page in this section uses synthetic placeholder values where examples need them; the patterns transfer to real GameDatabase content unchanged.

Tools You'll Reach For

Tool When
pagonia-manager Installing mods, managing profiles, deploying to a real game install with rollback. Most modders only need this.
pagonia-patcher Hand-authoring patches, validating mod.yaml files, schema-validating before publishing. validate-mod also advises on overlay conflict risk โ€” prefer additive Incremental/Template over destructive Replace/Unload so your mod stacks cleanly with others (see Patch Conflict Model).
pagonia-paker Inspecting .pak archives, building Pattern B overlay paks, classifying downloaded mods.
Catalog Browser โ†— Searching the extracted GameDatabase by entity / building / recipe / GUID โ€” invaluable when figuring out what to patch.

Downloads on the latest release, or via the Download tab.

Where Modding Fits

The Pagonia Editor that ships with the game lets you author all of it โ€” maps, scenarios, GameDatabase changes โ€” and publish it as a .pak mod; the community wiki on wiki.gg covers using it. Pagonia Land complements it, not replaces it: a structured map of the GameDatabase, declarative patches with conflict detection for the text / CI path, and the install / deploy / rollback lifecycle.