Home›Java›Mods›DynamicGuide
DynamicGuide
ModsJava

DynamicGuide

Java mod listed for Minecraft 1.20. Downloads from the MC Java Mods app on Android.

by ShadowedLeaves · on Modrinth

Dynamic Guide is a highly customizable Minecraft plugin that automatically delivers interactive book-based GUIs for fully customizable player interactions.

Which build do you need?

This mod ships a separate file for every mod loader and every version of the game. Pick both, then download — the wrong build installs fine and then does nothing in the game.

Mod loader

Minecraft version

⬇ Download for 1.21–1.21.11 · Paper⬇ Download for 1.20–1.20.6 · Paper⬇ Download for 1.21–1.21.11 · Purpur⬇ Download for 1.20–1.20.6 · Purpur
I don't know my version or loader
Open the Minecraft launcher and look at the profile you play on — it names both, like fabric-loader-1.21.4. The version also shows in the bottom-right corner of the game's main menu.
No loader in the profile name? Then it's plain Minecraft, and these mods won't run — you need Fabric or NeoForge installed first.
DynamicGuide — screenshot 1DynamicGuide — screenshot 2DynamicGuide — screenshot 3DynamicGuide — screenshot 4DynamicGuide — screenshot 5

DynamicGuide

Latest Version Total Downloads Open Issues License: MIT

Dynamic Guide is a highly customizable Minecraft plugin that automatically delivers interactive book-based GUIs for fully customizable player interactions.

Supported versions: Paper and Purpur 1.20.x - 1.21.x
Java: 17 (Paper/Purpur 1.20.5+ servers require Java 21 to run)

Features

Installation

  1. Download the latest release from Modrinth.
  2. Place the JAR in your server's plugins/ folder.
  3. Start or restart the server.
  4. On first run, default files are created in plugins/DynamicGuide/, including books/welcome.yml.

To build from source:

./gradlew build

The JAR will be in build/libs/.

Commands

Command Description
/guide <book> Open a guide book by ID or alias (player only).
/dynamicguide Open the admin book menu (player only).
/dynamicguide help Show available commands based on your permissions.
/dynamicguide <page> Open the admin menu on a specific page number.
/dynamicguide list List all loaded guide books.
/dynamicguide reload Reload configs and books.
/dynamicguide create <book> Create a new guide book.
/dynamicguide delete <book> Open the delete confirmation GUI (player only).
/dynamicguide rename <book> <newBook> Rename a guide book.
/dynamicguide duplicate <book> <newBook> Duplicate a guide book.
/dynamicguide give <book> [player] Give a guide item to yourself or another player.
/dynamicguide open <book> [player] Open a guide book for yourself or another player.
/dynamicguide edit <book> Open the in-game editor for a guide book.

Book IDs must use only letters, numbers, hyphens, and underscores (max 32 characters).

Permissions

Permission Description Default
dynamicguide.* Full access to DynamicGuide. op
dynamicguide.command.guide Use /guide. true
dynamicguide.command.list Use /dynamicguide list. op
dynamicguide.command.reload Use /dynamicguide reload. op
dynamicguide.command.give Use /dynamicguide give. op
dynamicguide.command.open Use /dynamicguide open. op
dynamicguide.editor Use /dynamicguide create, delete, rename, duplicate, and edit, plus admin menu book management. op
dynamicguide.book.<book> Open a specific book when open-to-all is disabled. not set

dynamicguide.* grants all listed child permissions. Books with open-to-all: true can be opened by anyone without a per-book permission.

Dependencies

Dependency Required Notes
Paper or Purpur 1.20.x - 1.21.x Yes Server software
PlaceholderAPI No Enables %placeholder% support in book content when installed

Configuration

config.yml

Option Description Default
prefix MiniMessage prefix used in plugin messages. [DynamicGuide] styled prefix
open-delay Delay in ticks before opening or giving join books. 5

messages.yml

All plugin and GUI messages can be customized. Supports MiniMessage formatting.

Book files (plugins/DynamicGuide/books/*.yml)

Each book is a YAML file with these settings:

Option Description
id Book identifier
title Book title (MiniMessage)
author Book author
pages List of page content strings (MiniMessage)
page-labels Optional display names for pages in the editor (MiniMessage)
aliases Alternate names used with /guide
open-to-all If true, any player can open the book without a per-book permission
join.give-on-first-join Give the guide item on a player's first join
join.open-on-first-join Open the book on a player's first join
join.open-on-every-join Open the book on every join
item.enabled Whether the physical guide item is enabled
item.material Bukkit material name for the guide item
item.name Display name for the guide item (MiniMessage)
item.lore Lore lines for the guide item (MiniMessage)
item.enchant-glint Show enchantment glint on the guide item

Support

Author

ShadowedLeaves

Quick facts

Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.

File checked by MCModsHub

These come from our own check of the pack file, not from the source page.

Explore more