Example of a guidebook with multiple categories
Example of an open entry
Toast that appears once a new entry is unlocked.
Description
Domix’s Guidebook is a simple, data-driven API for creating in-game guidebooks for Fabric mods.
It allows mod developers to define guidebook content entirely through JSON, including pages, images, items, and recipes, without needing to write custom UI or rendering code.
The API is designed to be lightweight, flexible, and easy to integrate. Mods can register their own guidebooks, provide custom assets, and extend the system with additional element types if needed.
The guidebook system was originally part of my Domix’s Creatures mod, and has since been reworked into a standalone API that can be reused across my own projects and integrated by other modders.
The guidebook is used by right-clicking an entity that has a corresponding entry, or by right-clicking while holding the guidebook in one hand and an item with an entry in the other. A small magnifying glass icon will appear under the cursor if an entry is available.
The Domix's Guidebook Team
