菜单配置

菜单默认存放在 /plugins/SweetInventory/menus 目录下，一个 .yml 文件代表一个菜单，文件名去除后缀名即为菜单 ID。

# 界面标题
title: '界面标题 %page%/%max_page%'
# 界面布局模板
inventory:
  - '框框框框框框框框框'
  - '上页页页页页页页下'
  - '框框框框框框框框框'
# (可选)分页器，注释该项则不使用分页器
page-guide:
  # 分页内容应该放在上述布局的哪些字符上
  slot: 页
  # 每一页的布局，翻页时会按顺序将以下字符替换掉上述布局的字符，再应用图标
  # 列表中每一个元素 (以 - 开头) 代表一页
  pages:
    - '一二一二一二一'
    - '二一二一二一二'
# 菜单图标列表
items: {}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# 基础变量

可以在菜单标题、图标文字中使用的基础变量

%page% - 当前页码
%max_page% - 最大页码

# alias-ids

(可选) 菜单别名，用于使用自定义的菜单名，通过 /menu open 命令等方式打开菜单。

alias-ids:
  - example

1
2

# title

(可选) 界面标题，支持基础变量与 PAPI 变量

title: '界面标题 %page%/%max_page%'

# inventory

界面布局模板，一行添加9个字符，总字符数量必须为9的倍数，每个字符代表一个图标位置。

inventory:
  - '框框框框框框框框框'
  - '上页页页页页页页下'
  - '框框框框框框框框框'

1
2
3
4

# bind-command

(可选) 菜单绑定的命令，允许玩家通过命令打开菜单。

bind-command: example

自 1.0.1 起，支持为命令添加参数，如下所示：

bind-command:
  # 菜单命令
  name: example
  # 也可以添加空格代表注册子命令
  #name: example foo bar
  # 参数不完整时提示帮助
  help-actions:
    - '[message]/example <a>'
  # 命令参数列表
  arguments:
    - { type: integer, name: a, range: '0, MAX' }

1
2
3
4
5
6
7
8
9
10
11

命令参数以列表形式编写，其中单个参数可以用 section 格式也可以用 json 格式编写，完整的单个参数配置如下所示

自 1.0.2 起，玩家执行命令需要权限 sweet.inventory.open.menu.%id% 才能打开菜单

# update-interval

(可选) 菜单图标更新周期（单位 ticks），设为 0 则不定期更新菜单图标。

update-interval: 1

# page-guide

(可选) 分页器配置，指定界面布局模板中，哪些字符代表分页内容，以及每页应该显示什么图标。

page-guide:
  # 分页内容应该放在上述布局的哪些字符上
  slot: 页
  # 每一页的布局，翻页时会按顺序将以下字符替换掉上述布局的字符，再应用图标
  # 列表中每一个元素 (以 - 开头) 代表一页
  pages:
    - '一二一二一二一'
    - '二一二一二一二'

1
2
3
4
5
6
7
8

# items

界面图标配置，详见菜单图标配置。

items:
  图标1: {}
  图标2: {}
  # ...

1
2
3
4

上次更新: 2026/02/20, 12:40:50

← 命令菜单图标配置→