Wiki 9Minecraft Wiki 9Minecraft

Guide API Wiki & Guide

Guide-API is a robust library mod for Minecraft that provides a standardized framework for modders to create interactive, in-game documentation books, eliminating the need for external wikis.

Overview

Guide-API serves as a foundational utility for the Minecraft modding ecosystem. Its primary purpose is to allow developers to register and display custom guide books for their mods. By handling the technical complexities of GUI rendering, book registration, and content organization, it ensures that players can access comprehensive tutorials and item information directly within the game environment.

A Minecraft book interface from Guide API displaying a welcome message

Unlike many other documentation mods that rely heavily on external JSON files, Guide-API is primarily code-driven, allowing for dynamic content that can adapt based on a mod's configuration or the player's progress. It is a lightweight solution that has been adopted by numerous high-profile mods to improve user experience and accessibility.

Reference

ReferenceGuideConfigurationFAQ