Back to mods
Guide project artwork

CurseForge · Minecraft mod

Guide

An interactive in-game guidebook mod featuring smooth UI rendering, Markdown parsing, and 3D multiblock previews.

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Guide release matches 1.20.1 Forge?

Updated 6 days ago
Best match for your filters Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization)
Game version 1.20.1
Loader Forge

Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization) targets 1.20.1 with Forge. The project page does not say whether this file belongs on the client, dedicated server, or both. No extra mods listed for this file.

Where it goes

Is Guide required on the client, server, or both?

The project page does not say whether this file belongs on the client, dedicated server, or both.

Client Source doesn’t say
Dedicated server Source doesn’t say
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source does not explicitly classify this release as client-only or server-only.

What else does Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization) need?

Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization) on 1.20.1 Forge. Every mod below is checked against that same setup.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

2 listed on this file 2 pulled in by those mods
Just Enough Items (JEI) Optional for Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization)
optional
Matching file found Matched file: 15.75.0.236 for Forge 1.20.1
Curios API Optional for Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization)
optional
Matching file found Matched file: curios-forge-5.14.1+1.20.1.jar
MezzConfig Needed by Just Enough Items (JEI)
pulled in
Matching file found Matched file: MezzConfig 0.7.1 for Forge 1.20.1
MezzConfigGUI Needed by Just Enough Items (JEI)
pulled in
Matching file found Matched file: MezzConfig GUI mc1.20.1-0.5.11 for Forge

2 extra mods were pulled in by other dependencies. Indented rows show who needs each one. We only count dependency files that match this setup. A file for another loader does not fill the gap.

Before you install it

Add Guide without breaking your instance.

Built for Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization) on 1.20.1 Forge. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization). It targets 1.20.1 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    The project page does not say whether this file belongs on the client, dedicated server, or both.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside Guide Forge 1.9.0 (Journal, Scanner, Keybinds, Customization). It opens that exact file at the source.

About this project

What does Guide add?

Guide — Interactive in-game guidebooks for Minecraft

GitHub release version badge MIT License badge GitHub open issues badge GitHub stars badge

Minecraft Forge 1.20.1 badge NeoForge 1.21.1 badge Java 17 and 21 badge Gradle build badge

🧱 Render complex multiblocks. Parse Markdown right inside the UI.
🎬 Play video, GIFs and images — on Windows, macOS and Linux via FFmpeg.
🎨 Fully customizable themes, per-book overrides, custom colors and chapter backgrounds, optional visual effects.

Download on CurseForge Download on Modrinth View source on GitHub Join the Discord server

Features section

📚 Interactive Books


Direct-from-disk compilation. Multi-book namespaces, zero JAR packing. Full command suite for listing and opening books.

sidebar · search · /guide list · /guide open · unlock_tag · index · hot-reload
🧱 Multiblock Projection


Preview and assemble complex structures step by step.

layers · rotation · zoom · progress HUD · NBT
📝 Markdown Engine


Full Markdown rendered live inside the GUI.

tables · links · spoilers · items · mobs · sounds · indentation · search · fulltext
🎬 Multimedia


Video, GIF and image playback directly in the book.

JavaCV · FFmpeg · GIF · WebP · URL · fullscreen · ducking · cache
📔 Explorer's Journal


A personal notebook stored in the player's NBT. Notes, live Markdown preview, checklists, tables and spoilers.

notes · editor · preview · checklists · markdown · NBT · sync
🔭 Guide Scanner


Right-click a block, mob, dropped item or fluid to jump straight to the matching chapter.

blocks · mobs · items · fluids · @bind: · @bind_tag: · choice screen
⌨️ Guide Keybinds


Configurable hotkeys to open the book or the journal without touching the inventory.

B · N · rebindable · inventory-aware · Curios-aware
🎨 Themes & Backgrounds


Every UI element is customizable in-game via RGB picker, including chapter backgrounds.

per-book · colors · chapterBackground · color · image · URL · effects · lock
🖼️ Universal Images


PNG, JPEG, BMP and GIF supported everywhere — icons, backgrounds, media.

PNG · JPEG · BMP · GIF · local · server · URL
🎒 Curios Integration


Optional. When Curios is installed, the book and journal can sit in the belt slot and appear on your model.

belt · render · optional
🧩 Mod & Quest Hooks


JEI bindings, in-book checkboxes, server-synced progress.

@bind: · @bind_tag: · quests · UUID · NBT
🔒 Book Gating


Hide books until a per-player unlock tag is granted by any command source.

unlock_tag · KubeJS · FTB Quests · advancements

Feature Deep Dive section

🔒 Book Gating • Per-Player Unlock Tags: Add unlock_tag to any book.json and the book stays hidden in the selector until the player holds the matching tag. Perfect for tutorial books, endgame manuals, or story-gated content.

• Command-Driven: /guide unlock <tag> and /guide lock <tag> grant or revoke tags; both accept an optional player argument (OP level 2) for admins. /guide unlocks lists your active tags.

• Modpack-Friendly: Any system that can dispatch a command works — KubeJS events, FTB Quests rewards, advancements, or custom script packs. State is stored per-player in server-side NBT and synced on login and after every change.
📔 Explorer's Journal • Personal Notebook: The guide_diary item opens a private list of notes stored in the player's NBT. Every note holds a title, a body, a creation / update timestamp, and the coordinates + dimension where it was created. Notes survive relogs, dimension changes and client reinstalls; other players never see them, even on a server.

• Editor & Live Preview: The editor is a true multiline text box with cursor navigation, clipboard support (Ctrl+A/C/V/X) and a themed scrollbar you can drag. The preview renders the note the same way the book does — colors, styles, links, tables, dividers, spoilers and checklists — and refreshes with a 200 ms debounce while you type.

• Interactive Checklists: Markdown-style checkboxes (- [ ] / - [x]) toggle on left-click inside the preview. State is stored inside the note itself and saved on every click. Completed tasks show a green checkmark and a strikethrough; task color is set with an &-code prefix before the checkbox (&e- [ ], &c- [ ]).

• Journal Markdown Support: &0–&f colors, &l/&o/&n/&m styles, &r reset, external links [text](https://…), dividers (---, &6---, &l&9---), tables with wrap and drag-scroll, spoilers (@spoiler: / @endspoiler), and checklists. The editor converts &x into §x on the fly, so authors never type the section sign directly.

• Network Sync: Two payloads keep the journal in sync — a sync payload (server → client, sent on login) and an update payload (client → server, sent on create / update / delete). Last-write-wins conflict resolution, no confirmation roundtrip.
🔭 Guide Scanner • One-Click Lookup: The guide_scanner item resolves the registry ID of a block, mob, dropped item or fluid and looks it up in the same binding map used by JEI and the G-key shortcut (@bind: / @bind_tag:). A single match opens the chapter instantly; multiple matches open a themed selection screen with a collapsible tree — one book expanded at a time, chapters nested underneath, chapter icons shown.

• Entity Raycast: Uses a custom AABB-clip raycast so small dropped items and thin hitboxes are detected correctly — vanilla projectile raycast misses them.

• Fluid Fallback: Scans water and lava by fluid ID first, then falls back to the bucket ID (water_bucket / lava_bucket) if no binding is found for the fluid itself.

• Cumulative Index: The scanner reads from itemToChapterRefMap, a second index that survives book reloads and covers every visible book — no need to open a book first.
⌨️ Guide Keybinds • Two Hotkeys: B opens the book selector and N opens the journal. Both are bound to the Guide category and can be rebound at any time in Options → Controls → Guide.

• Inventory-Aware: Each key only fires if the matching item (guide_book or guide_diary) is in your main inventory, off-hand, or a Curios slot. No item, no action — this prevents bypassing the book gating system with a hotkey.
📚 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. Book order can be controlled via the optional index field in each book.json.
⚙️ 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.

• Book Listing & Direct Open: /guide list prints all books visible to the client (with index, namespace, dev flag and display name); /guide list server shows what the server is distributing; /guide open <namespace> opens any book by ID with tab-completion.

• 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.

• Full-Text Search Overlay: The sidebar search scans chapter content, not just titles. Typing a query opens an overlay with snippets around every match, grouped by chapter. Click a snippet to open the chapter, scroll to the matched line, and highlight the query in-place. The sidebar also keeps chapters that only match by content.

• 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.

• In-Chapter Search (Ctrl+F): A browser-style find panel opens at the bottom of the chapter area. Every match is highlighted (active one in a different color); jump between matches with ↑ / ↓ or Enter / Shift+Enter, with a live N / M counter. Spoilers containing a match auto-expand; spoilers without a match stay collapsed. Search highlight colors are themeable via searchHighlightColor and searchHighlightCurrentColor.
🧩 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. Supports PNG, JPEG, BMP and GIF (first frame).

• 3D Item & Block Models (@item:): Render rotating 3D item and block models inline in the page. Size is per-instance (16–128 px), alignment is configurable (left / center / right), and both flat items and full blocks respect the declared size. Hover for a tooltip with the registry ID and mod name.

• 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.
🎬 Built-in Media System • Video Playback: Play local and remote video files (mp4, avi, mkv, webm) directly inside guide pages using the @video: command. Supports direct HTTP(S) links with automatic caching, and includes a custom player with play/pause, stop, replay, volume slider, fullscreen, and a draggable progress bar with seek support.

• GIF and Image URL Support: Use direct HTTP(S) links in @gif: and @image: to load animated GIFs and static images (PNG, JPEG) from the internet. Files are cached in config/guide/cache/media/ for offline reuse.

• Sound Integration: Use the @sound: command to embed clickable sound buttons that play custom audio files from the book's sounds/ folder. Supports per-page playback with automatic music ducking.

• Smart Background Music Ducking: When a video or custom sound starts, the mod automatically pauses background music and restores it after playback ends.
🎨 Themes & Chapter Backgrounds • Built-in UI Settings Menu: Customize every interface element — panels, borders, buttons, scrollbars, tables, media player — directly in-game using an interactive RGB color picker. Create, edit, and save themes seamlessly without leaving the game.

• Chapter Backgrounds: Set custom backgrounds for your chapters directly in the game menu. You can choose a solid color (with adjustable transparency), a local image, or even a direct URL. Supports PNG, JPEG, BMP and GIF (first frame).

• Per-Book Overrides: Set a theme field in book.json to force a specific theme for a book; the global theme is restored when the book is closed. Priority: book theme > locked theme > global theme.

• Theme Sharing & Modpacks: All your custom UI settings and backgrounds are automatically saved as JSON files in config/guide/themes/. Modpack creators can easily share these JSON files to distribute pre-configured designs.
🔗 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:mod_id:item to trigger matching guide pages directly inside JEI, or click guide item passposts to instantly pull up active recipe sheets.

• Curios Belt Slot: The book and journal declare compatibility with the Curios belt slot through a data-driven tag. When Curios is installed, the equipped item is rendered on the player's model, and the B / N keybinds pick it up from there as if it were in the inventory. Curios is a soft dependency — the mod loads and runs fine without it.

Commands section

Command Description
/guide Open the main book catalog from anywhere — no item required
/guide reload Hot-reload all markdown, textures, JSON and themes without restarting the game
/guide list List all books visible to the client. Click a line to insert /guide open <namespace> into chat; hover for details
/guide list server List books the server is currently distributing. Shows index, namespace, dev marker and disk path in hover
/guide open <namespace> Open a specific book by namespace from chat. Supports tab-completion
/guide give <book|scanner|diary> [player] Spawn a Guide item into your inventory, or into another player's with OP 2. Falls back to player.drop() when the inventory is full. 1-second per-player cooldown
/guide unlock <tag> [player] Grant an unlock tag to yourself or another player (OP 2 for other players)
/guide lock <tag> [player] Revoke an unlock tag from yourself or another player (OP 2 for other players)
/guide unlocks List all unlock tags currently held by you
/guide unlocks clear [player] Wipe every unlock tag from yourself, or from another player with OP 2. Useful for testing and admin housekeeping

• All commands except /guide list server, /guide reload server-side, and player-targeted unlock / lock / give variants are available to all players by default — no OP or cheat requirements.

Supported Versions section

Loader Game Version JDK Status Branch
Minecraft Forge logo Forge 1.20.1 1.9.0+ 17 🟢 Stable forge-1.20.1
NeoForge logo NeoForge 1.21.1 1.7.0+ 21 🟢 Stable neoforge-1.21.1

• Both branches share the same feature set — multimedia, Markdown rendering, multiblock projection and book gating are on par. One small difference: on Forge, right-clicking the Curios belt slot opens the equipped item's screen (via ICurioItem.curioRightClick); on NeoForge this is no longer part of the Curios API, so use the N / B keybind instead.

Integrations section

🧩 JEI Bind chapters to items with @bind:mod_id:item. Click guide item passposts to instantly open recipes. Optional — Guide works fine without it.
🎒 Curios Soft dependency. When installed, the guide_book and guide_diary can be equipped in the belt slot; the equipped item is rendered on the player's model, and the B / N keybinds pick it up from there. The slot itself appears automatically for any player once the mod is loaded — no manual configuration required.
🎬 FFmpeg / JavaCV / JavaCPP Video decoding, transcoding, and frame-level media access through native FFmpeg binaries, wrapped by JavaCV and bundled via JavaCPP for Windows, macOS, and Linux.
💾 Media Cache Automatic background music ducking during playback, plus offline media caching in config/guide/cache/media/.
🔒 KubeJS / FTB Quests / Advancements Book gating hooks into anything that can dispatch a command. Grant tags with /guide unlock <tag> from KubeJS events, FTB Quests rewards, advancement functions, or script packs.

Directory Structure section

📁 config/guide/books/[book_id]/
┣ 📂 chapters/                 # Content sections directory
┃  ┣ 📄 index.md               # Built-in primary index (English)
┃  ┣ 📄 introduction.md        # Built-in first chapter (English)
┃  ┗ 📂 your_language/         # Language-specific files folder
┃     ┣ 📄 index.md            # Primary index table of contents
┃     ┗ 📄 introduction.md     # Your first guidebook chapter
┣ 📂 lang/                     # Localization files
┃  ┣ 📄 en_us.json             # Localization table for titles and layout indices
┃  ┗ 📄 your_language.json     # Custom language file
┣ 📂 models/                   # Local guidebook 3D model data
┣ 📂 sounds/                   # Background audio assets
┃  ┗ 🎵 your_sound.ogg         # Background music or ambient .ogg file
┣ 📂 videos/                   # Local video files for @video:
┃  ┗ 🎥 your_video.mp4         # Video file playable in the book
┣ 📂 textures/                 # User interface and image assets
┃  ┗ 🖼️ item/your_logo.png     # Local image and animated .gif storage
┣ 📂 structures/               # Structural schematic data
┃  ┗ 🏗️ your_structure.nbt     # Multi-block .nbt blueprint files
┗ 📄 book.json                 # Metadata configuration (Title, catalog icon, namespace)
Example book.json:
{
  "name": "[book_id].book.guide",
  "namespace": "[book_id]",
  "default_chapter": "introduction",
  "icon": "your_logo.png",
  "bg_music": "background_music (without.ogg)",
  "theme": "standard",
  "dev_only": false,
  "index": 0,
  "unlock_tag": ""
}

• index is optional. Books are sorted by it in the selector (lower = earlier). Books without index fall to the end, sorted by namespace.

• unlock_tag is optional. Leave it empty to keep the book public; set a tag (e.g. "secret") to hide the book until the player receives that tag via /guide unlock secret. Tags are per-player and persist across sessions.

Themes section

• Built-in UI Settings Menu: Customize every interface element — panels, borders, buttons, scrollbars, tables, media player — directly in-game using an interactive RGB color picker. Create, edit, and save themes seamlessly without leaving the game.

• Chapter Backgrounds: Set custom backgrounds for your chapters directly in the game menu. You can choose a solid color (with adjustable transparency), a local image, or even a direct URL. Supports PNG, JPEG, BMP and GIF (first frame).

• Per-Book Overrides: Set a theme field in book.json to force a specific theme for a book; the global theme is restored when the book is closed. Priority: book theme > locked theme > global theme.

• Theme Sharing & Modpacks: All your custom UI settings and backgrounds are automatically saved as JSON files in config/guide/themes/. Modpack creators can easily share these JSON files to distribute pre-configured designs.

Requirements section

Component Minimum Recommended Notes
Minecraft 1.20.1 · 1.21.1 1.20.1 or 1.21.1 Pick the branch that matches your loader
Loader Forge 47.x+
NeoForge 21.x+
Latest stable release Only one is required — choose per branch
Java JDK 17
JDK 21
17 for Forge
21 for NeoForge
Version must match the loader branch
JEI (optional) — Latest for your MC build Only needed for recipe integration via @bind:
Curios (optional) — Latest for your MC build Only needed for the belt slot integration and on-model rendering

• Guide works standalone — JEI, Curios, Quests, and other integrations are entirely optional.

Reporting Issues section

Found a bug or encountered a crash? Open a ticket on the Issue Tracker.

Info required Example
Minecraft version 1.20.1 · 1.21.1
Loader + version Forge 47.4.20+ · NeoForge 21.1.0+
Guide mod version 1.9.0 · 1.7.0-NeoForge
Related mods List of mods that may interact with Guide
Screenshots Attach if the issue is layout-related
Crash report Full latest.log or crash-report in a code block

• The more details you provide, the faster the issue can be resolved.

GitHub Issues CurseForge Comments Discord

Credits section

Project Author / Team Contribution
🧩 Just Enough Items (JEI) mezz In-game recipe integration
🎒 Curios TheIllusiveC4 Slot framework used for the belt integration
⚒️ Minecraft Forge LexManos · cpw FML ecosystem · MCP tools
🦊 NeoForge NeoForge Team Modern modding platform for 1.21.1
🎬 JavaCV bytedeco Cross-platform Java wrapper for native media libraries
🎬 JavaCPP bytedeco Native bindings & prebuilt binaries for FFmpeg / OpenCV
🎞️ FFmpeg FFmpeg Team Video decoding, transcoding & stream handling
💙 Open Source Community Everyone Bug reports, docs, and support

License section

Licensed under the MIT License — free to use, modify, and distribute in any modpack environment.

You are allowed to include Guide in your modpack.
Any modpack that uses Guide takes full responsibility for user support queries.
We only support official builds, not custom modified jars.

Footer — Made with love for the Minecraft modding community by deaddiesel

Made with ❤️ for the Minecraft modding community

© deaddiesel · Guide Mod

Project description from CurseForge.

Pick your setup

Guide by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

2 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Guide versions and loaders

14 of 22 releases match
Clear filters

Looking for an older file? The official CurseForge project page is in Resources.