GuideBook Mod — Guide

Formatting and Styling

Text within a GuideBook can be styled using the <span> tag or standard Minecraft color codes.

Text Styles

The following attributes can be applied to a <span> tag: * color: Hex code (e.g., #FF0000) or Minecraft color names. * bold: true / false * italic: true / false * underlined: true / false * strikethrough: true / false * obfuscated: true / false (Magic text)

Example Syntax

<paragraph>
 <span color="gold" bold="true">Important:</span> 
 This is a styled sentence within the guide.
</paragraph>

Interactive Elements

GuideBook allows for rich interactivity beyond simple text reading.

Displaying Items

Use the <item> tag to render a 3D item stack directly on the page. * Attributes: id (Item ID), count (Quantity), nbt (NBT data string).

Images

Custom textures can be embedded using the <image> tag. * Attributes: src (Resource location, e.g., modid:textures/gui/image.png), width, height.

Hyperlinks

Links can be used to navigate the book or interact with the system. * Internal Link: <link target="section_id">Click here</link> * Web Link: <link url="https://example.com">Visit Website</link> * Clipboard: <link clipboard="/give @p stone">Copy Command</link>

A page showing a combination of text, items, and recipes

Advanced Mechanics

Element Conditions

Content can be dynamically hidden based on certain criteria using the condition attribute. This is widely used in "Expert" modpacks to hide information until a player reaches a certain milestone. * Mod Presence: condition="mod:jei" (Only shows if JEI is installed). * Game Stages: condition="gamestage:stage_name" (Requires the Game Stages mod).

Template System

Templates allow creators to define a layout once and reuse it across multiple pages. This is ideal for bestiaries or item catalogs where the format remains consistent but the data (name, image, description) changes.

Localization

GuideBook supports standard Minecraft .lang and .json localization files. Instead of hardcoding text in the XML, creators can use translation keys (e.g., guide.modid.welcome) to support multiple languages.