DynamicGuide
Dynamic Guide 是一个高度可定制的 Minecraft 插件,能够自动提供基于交互式书籍的 GUI,用于实现完全可定制的玩家交互。
支持的版本: Paper 和 Purpur 1.20.x - 1.21.x
Java: 17(Paper/Purpur 1.20.5+ 服务器需要 Java 21 才能运行)
功能特性
- 从
plugins/DynamicGuide/books/ 加载多个指南书籍
- 使用
/guide <book> 通过书籍 ID 或别名打开书籍
- 冒险书籍 GUI,每本书最多支持 100 页(每页 1,024 个字符)
- 在书籍内容、物品文本和插件消息中使用 MiniMessage 格式化
- 可选地在书籍内容中使用 PlaceholderAPI 占位符
- 通过权限或
open-to-all 设置单书访问控制
- 物理指南物品:右键点击即可打开书籍
- 加入行为:首次加入时给予物品、首次加入时打开、或每次加入时打开
- 管理员 GUI(
/dynamicguide),包含分页书籍列表、重载和创建书籍操作
- 管理员菜单书籍操作:左键点击编辑,右键点击重命名,Shift+点击删除(带确认)
- 游戏内编辑器,支持编辑页面、别名、物品设置和加入开关
- 页面编辑器支持添加、编辑、重命名、删除(带确认)以及分页
- 别名编辑器优先显示书籍 ID(只读),并支持添加、删除(带确认)、分页及跨书别名冲突预防
- 物品编辑器支持启用/禁用、名称、材质、描述行和附魔闪烁效果
- 聊天输入框用于编辑页面内容、显示名称、别名、物品字段、描述行,以及创建或重命名书籍
- 书籍、页面和别名的删除确认 GUI
- GUI 返回导航;关闭菜单时如有可用则重新打开上一个屏幕
- 支持创建、删除、重命名、复制、给予、打开、编辑、列出和重载书籍的命令
- 可自定义的
config.yml 和 messages.yml
- 首次安装时包含一个默认的
welcome 示例书籍
安装
- 从 Modrinth 下载最新版本。
- 将 JAR 文件放入服务器的
plugins/ 文件夹中。
- 启动或重启服务器。
- 首次运行时,会在
plugins/DynamicGuide/ 中创建默认文件,包括 books/welcome.yml。
从源代码构建:
./gradlew build
JAR 文件将位于 build/libs/ 中。
命令
| 命令 |
描述 |
/guide <book> |
通过 ID 或别名打开指南书籍(仅限玩家)。 |
/dynamicguide |
打开管理员书籍菜单(仅限玩家)。 |
/dynamicguide help |
根据权限显示可用命令。 |
/dynamicguide <page> |
在特定页码打开管理员菜单。 |
/dynamicguide list |
列出所有已加载的指南书籍。 |
/dynamicguide reload |
重载配置和书籍。 |
/dynamicguide create <book> |
创建新的指南书籍。 |
/dynamicguide delete <book> |
打开删除确认 GUI(仅限玩家)。 |
/dynamicguide rename <book> <newBook> |
重命名指南书籍。 |
/dynamicguide duplicate <book> <newBook> |
复制指南书籍。 |
/dynamicguide give <book> [player] |
将指南物品给予自己或其他玩家。 |
/dynamicguide open <book> [player] |
为自己或其他玩家打开指南书籍。 |
/dynamicguide edit <book> |
打开指南书籍的游戏内编辑器。 |
书籍 ID 只能使用字母、数字、连字符和下划线(最多 32 个字符)。
权限
| 权限 |
描述 |
默认值 |
dynamicguide.* |
完全访问 DynamicGuide。 |
op |
dynamicguide.command.guide |
使用 /guide。 |
true |
dynamicguide.command.list |
使用 /dynamicguide list。 |
op |
dynamicguide.command.reload |
使用 /dynamicguide reload。 |
op |
dynamicguide.command.give |
使用 /dynamicguide give。 |
op |
dynamicguide.command.open |
使用 /dynamicguide open。 |
op |
dynamicguide.editor |
使用 /dynamicguide create、delete、rename、duplicate 和 edit,以及管理员菜单书籍管理。 |
op |
dynamicguide.book.<book> |
当 open-to-all 禁用时,打开特定书籍。 |
未设置 |
dynamicguide.* 授予所有列出的子权限。设置为 open-to-all: true 的书籍任何人都可以打开,无需单独的书籍权限。
依赖
配置
config.yml
| 选项 |
描述 |
默认值 |
prefix |
插件消息中使用的 MiniMessage 前缀。 |
[DynamicGuide] 样式化前缀 |
open-delay |
打开或发放加入书籍前的延迟(以刻为单位)。 |
5 |
messages.yml
所有插件和 GUI 消息均可自定义。支持 MiniMessage 格式。
书籍文件 (plugins/DynamicGuide/books/*.yml)
每本书都是一个包含以下设置的 YAML 文件:
| 选项 |
描述 |
id |
书籍标识符 |
title |
书籍标题 (MiniMessage) |
author |
书籍作者 |
pages |
页面内容字符串列表 (MiniMessage) |
page-labels |
编辑器中页面的可选显示名称 (MiniMessage) |
aliases |
与 /guide 命令配合使用的别名 |
open-to-all |
如果为 true,任何玩家无需特定权限即可打开此书 |
join.give-on-first-join |
在玩家首次加入时发放指南物品 |
join.open-on-first-join |
在玩家首次加入时打开此书 |
join.open-on-every-join |
在每次加入时打开此书 |
item.enabled |
是否启用实体指南物品 |
item.material |
指南物品的 Bukkit 材质名称 |
item.name |
指南物品的显示名称 (MiniMessage) |
item.lore |
指南物品的背景故事文本行 (MiniMessage) |
item.enchant-glint |
是否在指南物品上显示附魔光泽 |
支持
作者
ShadowedLeaves
DynamicGuide
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
- Multiple guide books loaded from
plugins/DynamicGuide/books/
- Open books with
/guide <book> using a book ID or alias
- Adventure book GUI with up to 100 pages per book (1,024 characters per page)
- MiniMessage formatting in book content, item text, and plugin messages
- Optional PlaceholderAPI placeholders in book content
- Per-book access control via permissions or
open-to-all
- Physical guide items that open books on right-click
- Join behavior: give item on first join, open on first join, or open on every join
- Admin GUI (
/dynamicguide) with paginated book list, reload, and create-book actions
- Admin menu book actions: left-click to edit, right-click to rename, shift-click to delete (with confirmation)
- In-game editor for pages, aliases, item settings, and join toggles
- Page editor with add, edit, rename, delete (with confirmation), and pagination
- Alias editor with the book ID shown first (display-only), plus add, delete (with confirmation), pagination, and cross-book conflict prevention
- Item editor for enable/disable, name, material, lore lines, and enchant glint
- Chat input for editing page content, display names, aliases, item fields, lore lines, and creating or renaming books
- Delete confirmation GUIs for books, pages, and aliases
- GUI back navigation; closing a menu reopens the previous screen when available
- Commands to create, delete, rename, duplicate, give, open, edit, list, and reload books
- Customizable
config.yml and messages.yml
- Includes a default
welcome example book on first install
Installation
- Download the latest release from Modrinth.
- Place the JAR in your server's
plugins/ folder.
- Start or restart the server.
- 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
评论 0
登录后参与评分
还没有评论,来抢沙发吧