Patchouli Mod — Reference

Items and Blocks

Patchouli adds a single primary item that serves as the framework for all in-game documentation.

The Guide Book

• Item ID: patchouli:guide_book
• Properties: The Guide Book is a dynamic item. By itself, it is empty. It becomes a specific mod's manual when assigned a patchouli:book NBT tag.
• Crafting: While Patchouli does not provide a default recipe, most modpacks and mods add a simple recipe (e.g., a Book + a Lever or a Book + a Sapling) to grant the player the specific manual.

Blocks

Patchouli does not add any world-gen blocks or decorative blocks. It functions entirely as a library and UI-based mod. However, it can document every block from every other mod installed in the game.

Mechanics: Book Structure

Patchouli books are organized into a hierarchy of Categories, Entries, and Pages.

1. Categories: The top-level folders that group related topics (e.g., "Basics", "Tools", "Magic").
2. Entries: Individual articles within a category (e.g., "How to Mine", "The Iron Golem").
3. Pages: The actual content of an entry. An entry can have an unlimited number of pages.

Page Types

Patchouli includes several built-in page types to display different kinds of information:

• Text Page (patchouli:text): Displays formatted text. If it's the first page, it shows the entry title.
• Image Page (patchouli:image): Displays one or more images with an optional caption.
• Crafting Page (patchouli:crafting): Displays a 3x3 crafting recipe. Supports JEI integration.
• Smelting Page (patchouli:smelting): Displays a furnace/smelting recipe.
• Multiblock Page (patchouli:multiblock): Displays a 3D structure and allows the player to visualize it in the world.
• Entity Page (patchouli:entity): Renders a live 3D model of a mob or entity.
• Spotlight Page (patchouli:spotlight): Highlights a specific item and provides text about it.
• Quest Page (patchouli:quest): Displays a task that is marked as "complete" when a specific advancement is earned.

Multiblock Visualization

One of Patchouli's most powerful features is the ability to help players build complex structures. When viewing a Multiblock Page, players can click a button to "Visualize" the structure.

How it Works

• Ghost Blocks: A translucent version of the structure appears in the world at the player's cursor.
• Placement Guide: As the player places the correct blocks, the ghost blocks disappear.
• Rotation: Players can rotate the visualization to fit their desired orientation.
• Validation: The system checks if the blocks placed match the required block states (including NBT and properties).