GuideBook Mod — Reference
The Guidebook Item
While GuideBook is primarily a library for other mods, it includes a base item that players can use to access registered guides. In many modpacks, this item is provided to the player upon spawning or can be crafted manually.
Crafting Recipe
To create the basic Guidebook, combine a standard Book with a Crafting Table in any crafting grid.
| Item | Ingredients | Pattern |
|---|---|---|
| Guidebook | 1x Book, 1x Crafting Table | Vertical or Horizontal |
Usage
- Right-Click: Opens the Guidebook interface. If multiple books are registered in the modpack, a selection screen will appear.
- Search Bar: Modern versions of the mod include a search bar at the top of the interface to quickly find specific chapters or items.
XML Structure and Syntax
GuideBook uses a strict hierarchy inspired by HTML. Files are typically located in config/guidebook/ or within a mod's assets folder at assets/modid/guidebooks/.
Core Hierarchy
<book>: The root element containing the entire guide.<chapter>: Groups related sections together (e.g., "Getting Started").<section>: Represents a specific topic or page.<paragraph>: The basic unit of text. Supports automatic wrapping.<span>: Used for inline styling and formatting.
Common Attributes
| Element | Attribute | Description |
|---|---|---|
book |
id |
Unique identifier for the book. |
book |
title |
The display name shown in the GUI. |
book |
icon |
The Item ID (e.g., minecraft:apple) used as the book's icon. |
chapter |
title |
The name of the chapter. |
section |
title |
The header for the specific section. |
paragraph |
condition |
A string used to hide content (e.g., mod:botania). |
Displaying Recipes
One of the mod's most powerful features is the ability to pull recipes directly from the game's registry. This ensures that if a modpack changes a recipe, the guidebook updates automatically.
Recipe Tag
- By Output:
<recipe output="minecraft:furnace" />— Displays the first found recipe that results in a furnace. - By Key:
<recipe key="minecraft:stick" />— Displays a specific recipe by its registry name.
Supported recipe types include standard Crafting (Shaped/Shapeless), Smelting, Blasting, Smoking, and Campfire Cooking. Modded recipe types may require additional compatibility layers depending on the mod version.