Mag GUIs

插件

· 作者 Stralex_x

此插件允许您仅使用服务端软件,为 Minecraft 服务器添加自定义 Java 风格的 GUI!用这个专业的 GUI 替换您旧的笨重的自定义箱子 GUI 吧!

0 本站下载 0 关注 更新于 2 个月前

最新 1.0.0-purpur-26.2 · 26.2 · Purpur

一键开服(送7天)

MagDialogGUIs

适用于 Paper 和 Purpur 的原生 Minecraft 对话 GUI 框架。MagDialogGUIs 不使用箱子库存来构建菜单,而是利用 Mojang 的 Dialog API(Minecraft 1.21.6 新增,Paper 开发者 API 自 1.21.7 起支持)向玩家展示真正的原生对话窗口——包含文本字段、复选框、滑块、单选按钮以及可执行命令的按钮。

每个对话框都在简单的 YAML 文件(.mg)中定义,只需将其放入 plugins/MagDialogGUIs/guis/ 即可。无需编写代码。

支持:Paper 和 Purpur,Minecraft 1.21.7 至 26.2(有关单个源码树如何覆盖整个版本范围,请参阅下方的 构建)。

快速开始

  1. 将 jar 包放入 plugins/,启动服务器一次,然后停止它。
  2. 查看 plugins/MagDialogGUIs/guis/ —— 为你提取了四个示例文件:example.mg、nickname.mg、chat-colour.mg 和 settings-menu.mg。
  3. 再次启动服务器,并在游戏中运行 /example、/nickname、/chatcolour 或 /settings。
  4. 编辑 .mg 文件,然后运行 /magdialogguis reload。

.mg 格式

.mg 文件是纯 YAML 格式。顶层键如下:

键 类型 默认值 描述
name string 文件名 内部标识符。用于 open: 动作和 /magdialogguis open。
title string name MiniMessage 格式。对话框的标题。
external-title string (无) MiniMessage 格式。如果你使用了链接到本对话框的按钮,则显示在按钮上。
permission string (无) 打开此 GUI 所需的权限,无论是通过命令、/magdialogguis open 还是 open: 动作。
escape boolean dialogs.default-escape (位于 config.yml) 按 Escape 键是否关闭对话框。
columns int 自动 (1 或 2) 操作按钮布局的列数。
command map (无) 见下文。省略此项可使 GUI 仅通过 open: 或 /magdialogguis open 访问。
body list 空 参见 主体。
inputs map 空 参见 输入项。
actions map 空 (显示一个“关闭”按钮) 参见 动作。

所有文本值(title、label、主体 text、动作 label/tooltip 等)均作为 MiniMessage 进行解析,因此 <red>、<bold>、<gradient:...> 等均有效。所有文本值也会先解析 %占位符% —— 参见 占位符。

command

command:
  name: example      # 注册 /example
  aliases:
    - testdialog      # 以及 /testdialog

如果已存在同名命令,则跳过注册(并记录日志),除非 config.yml 中的 commands.protect-existing: false。

Body(主体)

条目列表,每个条目要么是文本消息,要么是物品图标。

body:
  - text: "<white>欢迎, <yellow>%player%</yellow>!"
    width: 300

  - type: item
    material: WRITABLE_BOOK       # 任何 Bukkit Material 名称
    description: "<gray>物品可用于说明你的对话框。"
    width: 32
    height: 32
    show-decorations: true
    show-tooltip: true

省略 type(或设置 type: text)即表示为文本条目。

Inputs(输入项)

inputs: 是一个映射,从 键(用于 %占位符% 并在 DialogResponseView 中显示)到其定义。支持四种类型,与 Minecraft 自身的对话框输入类型完全匹配。

text —— 文本字段。

inputs:
  NAME:
    type: text
    label: "<green>你的名字"
    width: 300          # 1-1024
    max-length: 32
    initial: "%player%"
    label-visible: true

boolean —— 复选框。

inputs:
  AGREE:
    type: boolean
    label: "<green>我同意"
    initial: false
    on-true: "true"    # 勾选时替换到 %AGREE% 的值
    on-false: "false"  # 未勾选时替换到 %AGREE% 的值

number —— 滑块。

inputs:
  LEVEL:
    type: number
    label: "<green>等级"
    min: 0
    max: 100
    step: 1              # 省略则为连续滑块
    initial: 50
    label-format: "%s: %s"   # 第一个 %s = 标签,第二个 = 当前值

option —— 单选 / 单选输入。

inputs:
  COLOUR:
    type: option
    label: "<green>颜色"
    width: 200
    label-visible: true
    options:
      - id: "red"
        display: "<red>红色"
        initial: false
      - id: "green"
        display: "<green>绿色"
        initial: true     # 最多只能有一个选项设为初始选中

options 也接受纯字符串列表(例如 - "red"),在这种情况下,该字符串同时用作 id 和显示文本。

Actions(动作)

actions: 是一个从按钮 ID 到其定义的映射。每个条目成为对话框上的一个按钮。如果完全省略 actions:,对话框将获得一个默认的“关闭”按钮(一种 notice-type 对话框)。

actions:
  submit:
    type: player            # 见下表
    label: "<green>提交"
    tooltip: "<gray>可选的悬停文本"
    width: 150
    command: "say Hello %NAME%"
    after: CLOSE             # CLOSE 或 NONE —— 每种类型的默认值见下文
type 有效载荷键 作用 默认 after
player command 以点击玩家的身份运行命令(前导 / 可选)。 配置默认值
console command 以控制台身份运行命令。 配置默认值
message message 向玩家发送一条聊天消息。 配置默认值
open gui 关闭当前对话框并通过 name 打开另一个 GUI。 CLOSE
close (无) 仅关闭对话框。 CLOSE
none (无) 不执行任何操作——可用作静态/装饰性按钮。 NONE

“config default”(配置默认值)对应 config.yml 中的 dialogs.default-after-action(开箱即用为 CLOSE)。可在任意动作上设置 after: 以覆盖此默认值。

占位符

在 MiniMessage 解析之前,所有文本值中均会解析以下占位符:

  • %player%、%uuid%、%world%、%x%、%y%、%z% — 始终可用。
  • %<input-key>% — 每个输入提交的值,在 actions: 中可用(布尔值解析为 on-true/on-false,数字以纯文本格式显示)。
  • 任何 %...% PlaceholderAPI 占位符,前提是已安装 PlaceholderAPI 且 config.yml 中设置了 placeholders.papi: true(此为默认设置)。

命令与权限

命令 权限 描述
/magdialogguis reload magdialogguis.admin 重新加载配置文件和所有 .mg 文件。
/magdialogguis list magdialogguis.admin 列出已加载的 GUI。
/magdialogguis open <gui> [player] magdialogguis.admin 为自己或其他玩家打开一个 GUI。
每个 GUI 自身的 command:(如果已设置) 该 GUI 的 permission: 打开该 GUI。

config.yml

请参阅随附的 config.yml 以了解所有选项,包括调试日志记录、严格验证(在遇到未知类型时使 .mg 文件整体失败,而非仅跳过该项)、默认的转义/操作后行为以及消息自定义。

限制

  • 按 Escape 键会在客户端关闭对话框,而不会向服务器发送往返请求,因此会话跟踪(类似 /magdialogguis list 的账目记录)无法检测到该操作——只有点击按钮、退出游戏或打开其他 GUI 才会更新状态。
  • 文本输入框始终为单行;多行文本区域尚未暴露(底层 API 对多行的支持在受支持的版本范围内各不相同)。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源