配置字段索引
按填写位置列出配置字段、别名与详细说明入口。
按填写位置查找字段，再进入对应章节查看类型、必填要求、默认行为与示例。括号内为别名，同一字段选择一种名称填写。
菜单顶层
| 字段 | 用途 | 详细说明 |
|---|---|---|
id | 指定菜单 ID；省略时由文件名确定 | 文件目录与 ID |
menu | 窗口设置 | 窗口设置 |
panels（panel、pane、panes） | 面板列表 | 面板 |
events（event、listener） | 打开前、打开后和关闭事件 | 菜单事件 |
bindings（binding、activator、activators） | 菜单打开入口 | 打开入口 |
nodes（node、scripts） | 命名文字与脚本 | 节点 |
tasks（task） | 延迟、周期执行的节点 | 任务 |
窗口：menu
| 字段 | 用途 | 详细说明 |
|---|---|---|
title | 窗口标题；可为文字或标题动画对象 | 窗口设置 |
rows | 箱子窗口行数，1～6 | 窗口设置 |
type | 容器类型，例如 CHEST | 窗口设置 |
virtual | 是否使用虚拟窗口 | 窗口设置 |
hide-player-inventory | 是否隐藏下方玩家背包 | 窗口设置 |
override-player-inventory | 是否将下方背包区域交给菜单使用 | 窗口设置 |
min-interact-interval | 两次交互的最小间隔，单位毫秒 | 窗口设置 |
标题动画：menu.title
| 字段 | 用途 | 详细说明 |
|---|---|---|
values | 使用统一间隔的标题列表 | 动画配置 |
frames | 每项填写文字与停留时间的标题帧列表 | 动画配置 |
period | 默认帧间隔，单位 tick | 动画配置 |
type（mode） | 播放模式 | 动画配置 |
pre-generate | 是否在打开时预先计算帧文字 | 动画配置 |
帧中的 value（title） | 当前标题文字 | 动画配置 |
帧中的 delay（last） | 当前帧停留时间，单位 tick | 动画配置 |
面板
| 字段 | 用途 | 详细说明 |
|---|---|---|
layout | 按字符安排图标与可用位置 | 布局与槽位 |
scale | 面板宽度、高度 | 布局与槽位 |
locate | 面板起点坐标 | 布局与槽位 |
icons（icon、item、items） | 固定图标映射 | 图标 |
pages | 分类页中的面板列表 | 翻页面板 |
default-page（default、def-page） | 分类页默认页，编号从 0 开始 | 翻页面板 |
generator | 数据列表设置 | 生成器 |
scroll | 滚动内容设置 | 滚动面板 |
crafting.listener | 物品交互区域变化时执行的动作 | 物品交互 |
scale 与 locate 使用两项整数列表。面板类型由 pages、generator、scroll、crafting 等结构确定，无需另填 type。
图标：icons 中的每一项
| 字段 | 用途 | 详细说明 |
|---|---|---|
id（key） | 图标 ID；通常直接使用 icons 中的键 | 图标 |
display | 集中填写物品外观 | 物品属性 |
condition（if、rule） | 子图标的选择条件 | 子图标 |
inherit | 子图标是否继承父图标外观与动作 | 子图标 |
sub（icons） | 按条件选择的子图标列表 | 子图标 |
action（actions、handler、click） | 点击时执行的动作 | 点击动作 |
update | 周期更新外观，单位 tick | 图标刷新 |
relocate | 周期重新选择子状态，单位 tick | 图标刷新 |
frames | 图标动画帧列表 | 动画配置 |
frames-prop（framesProperties、frames-properties、prop） | 默认动画间隔与模式 | 动画配置 |
图标内部的 sub（别名 icons）是子图标列表；面板的 icons 是图标映射，两者填写位置不同。
物品显示：图标外观或 display
| 字段 | 用途 | 详细说明 |
|---|---|---|
material（mat） | 原版材质 | 物品来源 |
head（skull） | 玩家头像或头颅纹理 | 物品来源 |
texture.source / texture.value | 物品来源及对应编号或内容 | 物品来源 |
name | 物品名称 | 物品属性 |
lore（lores） | 物品说明列表或多行文字 | 物品属性 |
enhancedLore | 将文字形式的 \n 拆成多行 Lore | Lore 与换行 |
amount（count、amt） | 显示数量 | 物品属性 |
damage（durability、dur） | 损伤值 | 物品属性 |
customModelData（model） | 整数模型编号 | 物品属性 |
itemModel（item_model、item-model） | 命名空间形式的物品模型 | 物品属性 |
glow（shiny） | 附魔闪光效果 | 附魔与发光 |
enchantments（enchantment、enchant） | 附魔名称与整数等级的映射 | 附魔与发光 |
flags（flag） | 物品提示标志列表 | 物品属性 |
hideTooltip（hide_tooltip、hide-tooltip） | 隐藏整个物品提示框 | 物品属性 |
unbreakable | 设置不可破坏 | 物品属性 |
nbt | NBT 键与文字、数字或布尔值的映射 | 物品属性 |
slot（slots、pos、position、positions） | 图标在面板内的位置 | 布局与槽位 |
动画帧的 delay（last） | 当前图标帧的停留时间 | 动画配置 |
图标动画：frames-prop
条件动作：action 或事件中的动作对象
| 字段 | 用途 | 详细说明 |
|---|---|---|
if / if_not | 单个条件满足／不满足时选择分支 | 条件动作 |
all / any / none | 全部／任意一个／全部不满足 | 条件动作 |
then / else | 条件满足／不满足时执行的动作 | 条件动作 |
case / when | 取得一个值并选择匹配分支 | 条件动作 |
case 中的 else（default） | 没有匹配分支时执行 | 条件动作 |
输入动作：action 中的输入对象
| 字段 | 用途 | 详细说明 |
|---|---|---|
catchers | 按顺序接收多项输入 | 玩家输入 |
catch | 输入保存的变量名 | 玩家输入 |
content | 告示牌初始文字列表 | 玩家输入 |
signLine（signIndex、index、line） | 读取告示牌的哪一行 | 玩家输入 |
cancel | 取消输入的关键词列表 | 玩家输入 |
reopen | 输入成功后是否重开原菜单 | 玩家输入 |
beforeInput / afterInput | 输入前／收到内容后执行 | 玩家输入 |
onRepeat / onCancel | 重试输入／取消输入时执行 | 玩家输入 |
点击类型与默认动作 def 的写法见点击动作。
打开入口：bindings
| 字段 | 用途 | 详细说明 |
|---|---|---|
command（commands、cmd、cmds） | 一个或多个绑定命令 | 打开入口 |
命令的 name、aliases、description、usage | 命令名称、别名与帮助信息 | 打开入口 |
命令的 permission / permissionMessage | 使用权限与没有权限时的提示 | 打开入口 |
命令的 arguments（argument、args） | 参数列表 | 打开入口 |
参数的 id（key、name、label） | 参数变量名 | 打开入口 |
参数的 type、optional、default | 参数类型、省略规则与默认值 | 打开入口 |
参数的 suggest / restrict | 提示列表与取值限制 | 打开入口 |
item（items） | 通过物品匹配表达式打开 | 打开入口 |
chat（chats） | 通过聊天内容打开 | 打开入口 |
shift_f | 潜行切换后按换手键的时间窗口，单位毫秒 | 打开入口 |
entity | 右键指定实体类型打开 | 打开入口 |
adyeshach（ady） | 与指定 Adyeshach NPC 交互时打开 | 打开入口 |
节点与任务
| 字段 | 用途 | 详细说明 |
|---|---|---|
节点的 type（handler） | 节点类型 | 节点 |
节点的 value（runnable、run、script） | 常量、文字或脚本内容 | 节点 |
节点的 throwable（throwError） | 是否打印执行错误 | 节点 |
任务的 delay / period | 首次延迟／重复间隔，单位 tick | 任务 |
任务的 async | 自动提交任务时的执行方式 | 任务 |
任务的 run | 节点或节点列表 | 任务 |
数据列表与滚动内容
| 字段 | 用途 | 详细说明 |
|---|---|---|
generator.source | 数据来源名称 | 生成器 |
generator.elements | 自定义或追加的元素列表 | 生成器 |
generator.output（template） | 每条元素的图标模板 | 生成器 |
generator.filter | 筛选显示的元素 | 生成器 |
generator.sortBy | 按指定元素字段的文字值排序 | 生成器 |
generator.data | 交给支持参数的数据来源读取的参数映射 | 生成器 |
scroll.colums | 滚动内容分组；字段拼写固定为 colums | 滚动面板 |
scroll.direction | 横向或纵向滚动 | 滚动面板 |
scroll.default-index | 默认滚动位置，编号从 0 开始 | 滚动面板 |
scroll.tail | 结束位置与循环方式 | 滚动面板 |
主配置：config.yml
| 字段 | 用途 | 详细说明 |
|---|---|---|
Workspaces.paths / Workspaces.filter | 菜单目录与文件名筛选 | 主配置 |
Workspaces.file-listener | 保存菜单文件后自动重载 | 主配置 |
GlobalNodes.enabled / GlobalNodes.paths | 启用全局节点与节点目录 | 主配置 |
GlobalNodes.filter / GlobalNodes.priority | 全局节点文件筛选与同名查找顺序 | 主配置 |
Kether.auto-placeholder-translate | 文本处理与消息扩展开关 | 主配置 |
Menu.virtual-by-default | 菜单未指定 virtual 时的默认模式 | 主配置 |
Menu.enable-raw-title-in-vanilla-inventory | 普通窗口的原始标题处理 | 主配置 |
Database.type | 数据库存储类型 | 主配置 |
Database.sql 中的 host、port、user、password、database、table | SQL 连接与数据表设置 | 主配置 |
Paste.service-type | 内容导出服务 | 主配置 |
Paste.services.<服务>.base-url | 所选导出服务的 API 地址 | 主配置 |
Paste.services.pastebin.dev-key | Pastebin 开发者密钥 | 主配置 |
特殊字段与限制
| 字段 | 状态 | 详细说明 |
|---|---|---|
物品 color | 染色设置不生效 | 物品染色 |
命令参数 incorrectMessage | 自定义错误提示不生效 | 命令参数 |
条件 atLeast（amount、at_least） | 数量阈值判断有已知问题 | 条件动作 |
generator.data | 仅由支持参数的数据来源读取 | 来源参数与扩展限制 |
generator.extension | 不支持动态属性计算 | 来源参数与扩展限制 |
Menu.default-name-color | 默认名称颜色设置不生效 | 文本与窗口默认值 |
Menu.default-lore-color | 默认 Lore 颜色设置不生效 | 文本与窗口默认值 |
Patch.enable-raw-title-in-vanilla-inventory | 旧配置位置，不控制当前标题开关 | 文本与窗口默认值 |
最后更新于