Banner

📘 Guide — Universal Documentation System

A lightweight, modular, and highly customizable in-game guide system for Minecraft Forge 1.20.1+. Perfect for modpack creators, server networks, or custom mod developers — featuring 100% data isolation, direct-from-disk media stream loading, and zero virtual resource pack overhead.

No more repackaging JAR files or setting up heavy resource packs — Guide provides a clean, modern screen interface that reads everything directly from your local disk at runtime.

✨ Key Features:

📚 Multi-Book Config Autonomy

Direct-from-Disk Compilation: Automatically maps and loads guidebooks from your local machine at config/guide/books/[book_id]/. No more packing files inside mod JAR archives.
Automated Blueprint Generation: On the very first launch, the mod extracts a complete, ready-to-build guidebook template into your config folder, protecting custom assets from being overwritten during modpack updates.
Clean Book Selector: Features a fully responsive book catalog viewport with active filtering, rendering isolated book namespaces cleanly with zero mod-ID conflicts.

⚙️ Hot-Reload & Dev-Friendly Pipeline

Runtime Layout Swapping (/guide reload): Edit markdown files, layout nodes, textures, or JSON localization tables on your disk and instantly re-populate the guidebook memory in-game. Available to all players by default with no OP/cheat requirements.
Quick-Access Chat Navigation (/guide): A dedicated chat handle that routes users directly to the main book catalog viewport from anywhere, removing item dependencies.
Developer Mode Toggle: Hide instructional manuals or blueprints from players via config/guide/guide-client.toml while keeping them active for developers.

🧭 Premium Navigation & Search Caret

Overhauled Search Box: Equipped with a clean vertical caret (|) that flawlessly executes movement sequences and text selections across both English and Cyrillic keyboard layouts.
Smart Sidebar Sub-Menus: Seamlessly nests dropdown sub-chapters (@submenu:) and spoilers behind clicks, optimizing render framerates and preventing layout clipping.
Unbreakable Tracking & History: Navigation memory locks the expanded state of sidebar submenus, and text hyperlink hitboxes mathematically track lines perfectly under any dynamic scrollbar offset.

🧩 Advanced Content Rendering

Natural Text Indentation Support: The Markdown engine fully respects space and tab blocks at the start of text sequences, allowing for structured nested lists without desyncing hyperlink areas.
Direct Media Streaming: Renders static images (@image:) and animated GIFs (@gif:) straight from the local book directory, completely neutralizing the checkerboard placeholder texture glitch.
Consolidated Multi-Block NBT Projection: The 3D hologram projector (PlacementProjector) and the page renderer (StructureRenderer) compile .nbt blueprints directly from the config folder. Creators can bundle multi-block structures natively into their guides without external datapacks.

🔗 Mod & Quest Integration

Live Server-Synced Checkboxes: Features a client-to-server interactive quest system. Quest completions are bound to player UUIDs and securely saved inside the server-side NBT structure, protecting progression files from local data wipes.
JEI Navigation Ready: Bind chapters to specific item entries using @bind:modid:item to trigger matching guide pages directly inside JEI, or click guide item passposts to instantly pull up active recipe sheets.

config/guide/books/[book_id]/ ├── chapters/ │ ├── your_language/ │ │ ├── index.md │ │ └── introduction.md │ ├── index.md ← Primary index table of contents │ └── introduction.md ← Your first guidebook chapter ├── lang/ │ ├── en_us.json ← Localization table for titles and layout indices │ └── your_language.json ├── models/ ← Local guidebook model ├── sounds/ ← Local storage for background music and .ogg files ├── textures/ ← Local image and animated .gif storage │ └── item/ │ └── your_logo.png ├── structures/ ← Multi-block .nbt blueprint files │ └── your_structure.nbt └── book.json ← Metadata (Title, book catalog icon, namespace) { "name": "[book_id].book.guide", "namespace": "[book_id]", "default_chapter": "intro", "icon": "your_logo.png", "bg_music": "your_music (without .ogg)", "dev_only": false }