Guide-API Village and Pillage Mod: Overview

What This Mod Does

Guide-API Village and Pillage Mod is a fork of Guide-API, using its own package and mod-id (guideapi-vp). It is a library for mod developers rather than a content mod for players, so installing it on its own adds no items or blocks to your world.

Its purpose is to let mod authors create an in-game guide book for their own mod. Guide-API handles the bookkeeping: it registers the book, places it in its own creative tab, and maintains it. The book itself is defined mostly in code, unlike JSON-driven alternatives such as Patchouli.

Because content lives in code, authors can build books that react to their mod's configuration, wrap lines and pages automatically so localized text does not overflow, and reference keybindings, internal constants, and balancing values so the book updates when those values change. Custom page and recipe types are supported, along with helper methods that generate parts of the book automatically. Vampirism is an example of a mod using it.