Guide

📘 Guide — Universal In-Game Documentation System

A lightweight, modular, and highly customizable in-game guide system for Minecraft Forge 1.20.1+.
Perfect for modpacks, custom mods, or server documentation — with built-in support for multiple books, markdown, 3D structures, JEI integration, and more.

✨ Key Features:

📚 Multi-Book Support

• Automatically detects book.json files from any mod's assets/<modid>/guide/.
• Clean selector menu with icons, titles, and filtering.
• Each book is isolated by namespace — no conflicts between mods.

⚙️ Developer-Friendly Config

• Toggle the built-in "Developer Manual" via config/guide/guide-client.toml.
• Hide dev content from players while keeping it available for creators.
• All configs organized under config/guide/ — clean and predictable.

🧭 Advanced Navigation

• Sidebar with search, favorites, item-based filtering.
• Submenus, spoilers, clickable links, and page pagination.
• Smooth scrolling + keyboard/mouse controls.

🧩 Rich Content Rendering

• Markdown parser with syntax highlighting (§6, §b, etc.)
• Images, GIFs, inline items, mob renders.
• 3D structure viewer with layers, rotation, zoom, and projection to world.
• Spoiler tags to hide lore, recipes, or advanced info behind clicks.

🔗 Mod Integration Ready

• Bind chapters to specific items using @bind:minecraft:diamond → opens chapter when clicking that item in JEI.
• Full JEI integration: click an item in the guide → open its recipe/use directly in JEI.
• Hot-reload system: edit .md files → press F5 → changes appear instantly.

❤️ Favorites & Persistence

• Mark chapters as favorites → they persist across sessions in guide-favorites.properties.
• Filter sidebar to show only favorited chapters or those bound to held item.

🛠️ For Mod Developers:

Add your own guide book in minutes:

assets/yourmod/guide/
── book.json          ← Title, icon, namespace, dev_only flag
└── chapters/
    ├── index.md       ← Table of contents (with optional icons*)
    └── intro.md       ← Your first chapter

Example book.json:

{
  "name": "your_mod.book.guide",
  "namespace": "your_mod",
  "default_chapter": "intro",
  "icon": "your_mod:textures/gui/book_icon.png",
  "dev_only": false
}

📦 Requirements:

• Minecraft 1.20.1
• Forge 47.x+
• Java 17+

💬 Feedback & Support:

Found a bug? Have a feature request? Want to contribute?

→ GitHub Issues
→ CurseForge Comments

📜 License:

MIT License — free to use, modify, and distribute. Credit appreciated but not required.