GuidebookAPI
by RealLeoxian
GuidebookAPI is a library for building in-game guidebooks, with a developer API that lets other mods add their own guide content and page types.
What it does
Guidebooks made with the API are defined mostly in Java code rather than in external data files. Developers use it to set up a guide, decide what it spawns with, and choose colors and content based on configuration. The library also lets a mod add custom page types, such as a page that shows a recipe, so a guide can present more than plain text.
The API is a fork of the GuideAPI mod originally made by TehNut. The maintainers changed parts of the internal API and some of the original code base, and removed or replaced some original features with others. Mods that use it can declare it as a hard dependency, or list it as optional so their guides still work when GuidebookAPI is not installed. Fabric API is required on Fabric. Servers that run it need every player to install it too. Files are published for Fabric and NeoForge for 1.20.6, released under the MIT License.
Key features
Java-defined guides
Guides are built in code instead of external files, so a mod can ship its guide logic alongside its other classes.
Custom page types
Mods can register page types beyond plain text, such as recipe pages, for presenting content inside a guide.
Configurable guide content
Guide content and appearance can change based on configuration assets, and the spawn behavior of guides can be adjusted.
Example guidebook
A sample guidebook accompanies the source code, showing how a guide is put together for developers reading the project.
Compatibility
Latest build for each game version and loader.
Only full game releases are shown. This mod publishes no snapshot builds.
Requirements
Dependencies declared by the latest file for each loader.
Required 1
Use cases
Mods with documentation
A mod author can give players an in-game book that explains items, machines or quests, without writing a separate documentation system.
Optional guide support
A mod can depend on GuidebookAPI as optional, so its guide works when the library is present and stays playable without it.
Who it’s for: Mod developers who want an in-game guide for their mod, and modpack authors who need guides from several mods to work together on Fabric or NeoForge servers for 1.20.6.
Questions
Does GuidebookAPI need Fabric API?
Does the server need GuidebookAPI?
Can a mod work without GuidebookAPI installed?
Which game versions does GuidebookAPI support?
In the catalog
GuidebookAPI is one of 3,514 Library mods on ModsFinder, and one of 2,348 Library mods for Fabric. 11,154 mods support Minecraft 1.20.6.
More from RealLeoxian
Similar mods
What the author says
GuidebookApi is a mod that allow the ease creation of guides with no hard dependency. Some of the features of this mod are: - Modify the guides has you want! You can change what guides spawn, if you want all the guides to spawn or the color of these!
Official listing
- Modrinth page
- modrinth.com/mod/guidebookapi
- Owner
- RealLeoxian
- Published
- 2023-12-13
- Updated on Modrinth
- 2024-06-04
- Facts verified
- 2026-10-15