Wiki 9Minecraft Wiki 9Minecraft

GuideBook Mod Wiki & Guide

GuideBook Mod is a comprehensive library and API for Minecraft that allows modders and modpack creators to design highly customizable, interactive in-game documentation using a flexible XML-based syntax.

Contents (3)
  1. Overview
  2. Key Features
  3. In this wiki

Overview

The GuideBook Mod serves as a powerful framework for creating in-game manuals and documentation. Unlike standard written books, GuideBook utilizes an XML-based system to handle complex layouts, including formatted text, images, item renders, and interactive recipes. It is designed to be lightweight and highly compatible, making it a staple for modpack creators who need to explain complex mechanics or progression systems to players.

A sample page from a GuideBook showing text and item icons

Key Features

  • XML-Driven Content: All book data is stored in easy-to-edit XML files.
  • Hierarchical Structure: Content is organized into Books, Chapters, Sections, and Paragraphs.
  • Automatic Pagination: The mod automatically handles text flow and page breaks.
  • Recipe Integration: Display crafting, smelting, and other machine recipes directly in the book.
  • Conditional Visibility: Hide or show content based on installed mods or a player's progress (via Game Stages).
  • Hyperlinks: Navigate between sections, open external URLs, or copy text to the clipboard.

Reference

ReferenceGuideConfiguration