> For the complete documentation index, see [llms.txt](https://simple.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://simple.superiormc.cn/arcmenu-wen-dang/pei-zhi-yu-guan-li/configuration-files.md).

# 配置文件说明

ArcMenu 的配置保存在 `plugins/ArcMenu/` 中。修改前应备份该目录，并根据所用服务端选择对应的配置文件。

## Paper、Folia 与 Leaf

以下路径均相对于 `plugins/ArcMenu/`。

| 文件或目录            | 用途                             | 修改后的操作                        |
| ---------------- | ------------------------------ | ----------------------------- |
| `config.yml`     | 默认语言、主菜单快捷键、操作方式等基本设置。         | `/arcmenu reload`             |
| `offset.yml`     | 调整菜单屏幕的位置和显示距离，可分别设置触摸模式与鼠标模式。 | `/arcmenu reload`             |
| `menus/`         | 菜单的文字、布局、点击区域和动作。              | `/arcmenu reload`             |
| `animations.yml` | 菜单动画及对应的元素设置。                  | `/arcmenu reload`             |
| `templates/`     | 可复用的菜单组件。                      | `/arcmenu reload all`         |
| `tooltip.yml`    | 提示框的文字大小、位置、背景和边框等样式。          | `/arcmenu reload all`         |
| `images/`        | 菜单、提示框和光标使用的 PNG 图片。           | `/arcmenu reload all`，并更新资源包。 |
| `languages/`     | 插件命令提示、错误提示等文字。                | `/arcmenu reload`             |

### 基本设置

`config.yml` 中常用的设置如下。修改已有文件中的对应字段，保留其他设置。

```yaml
language:
  default: zh_CN
  follow-player-locale: true

shortcuts:
  shift-f: true

mouse:
  policy: player-choice
  default: touch
```

| 字段                              | 说明                                                                |
| ------------------------------- | ----------------------------------------------------------------- |
| `language.default`              | 默认语言。内置 `zh_CN`（简体中文）和 `en_US`（英文）；控制台消息使用此语言。                    |
| `language.follow-player-locale` | 为 `true` 时，根据玩家客户端语言显示插件提示；没有对应翻译时使用默认语言。为 `false` 时，统一使用默认语言。    |
| `shortcuts.shift-f`             | 是否启用 Shift+F 主菜单快捷键。                                              |
| `mouse.policy`                  | `player-choice` 允许玩家选择；`force-touch` 强制触摸模式；`force-mouse` 强制鼠标模式。 |
| `mouse.default`                 | 允许玩家选择时，未设置个人偏好的玩家默认使用的模式，可填 `touch` 或 `mouse`。                   |

语言设置影响插件提示文字。自定义菜单中的标题和按钮文字，应在相应菜单文件中修改。

### 菜单文件

每个菜单使用一个 `.yml` 文件，例如 `menus/welcome.yml`。文件中的 `id` 用于打开菜单：

```
/arcmenu open welcome
```

菜单标识必须唯一。菜单中应保留一个 `main-menu: true` 的主菜单，供 Shift+F 使用；不要将多个菜单同时设为主菜单。

创建菜单的完整步骤见[第一个菜单](/arcmenu-wen-dang/ru-men/first-menu.md)。

### 图片与资源包

图片放入 `images/`，文件名和子目录名称使用小写。修改或新增图片后，执行 `/arcmenu reload all`，再更新玩家使用的资源包。

已安装 CraftEngine 时，随后执行 `/ce reload all`。未安装时，按[资源包配置](https://simple.superiormc.cn/arcmenu-wen-dang/pei-zhi-yu-guan-li/pages/JfPbYFTL9xk7jR5CbVN6#资源包配置)分发生成的资源包。

图片引用、文件限制与更新流程见[图片与资源包](/arcmenu-wen-dang/gong-neng-pei-zhi/resource-packs.md)。

### 生成文件与备份

| 路径                                   | 用途                  |
| ------------------------------------ | ------------------- |
| `generated/arcmenu-resourcepack.zip` | 用于分发或合并的资源包。        |
| `generated/` 中的其他文件                  | 插件生成的资源文件，通常无需手动修改。 |
| `backup-menu/`                       | 编辑器保存菜单时产生的备份（如有）。  |
| `data.properties`                    | 插件保存的数据，不作为菜单配置编辑。  |

修改图片应操作 `images/` 中的原始文件，再重建资源包；直接修改生成文件可能在下次重建时被覆盖。

## Spigot

Spigot 的菜单和快捷键配置位于 `plugins/ArcMenu/spigot/`。语言设置仍位于根目录的 `plugins/ArcMenu/config.yml`，语言文件位于 `plugins/ArcMenu/languages/`。

| 文件或目录        | 用途        | 修改后的操作            |
| ------------ | --------- | ----------------- |
| `config.yml` | 主菜单快捷键设置。 | `/arcmenu reload` |
| `menus/`     | 基础菜单配置。   | `/arcmenu reload` |

此表中的路径均相对于 `plugins/ArcMenu/spigot/`，例如快捷键配置的完整路径为 `plugins/ArcMenu/spigot/config.yml`。

### 主菜单快捷键

```yaml
shortcuts:
  shift-f: true
```

将 `shift-f` 改为 `false` 可关闭快捷键。菜单中仍应保留一个 `main-menu: true` 的主菜单。

### 菜单配置

菜单文件放在 `plugins/ArcMenu/spigot/menus/`，不要放入 Paper 使用的 `plugins/ArcMenu/menus/`。可从内置的 `example.yml`、`details.yml` 或[第一个菜单](/arcmenu-wen-dang/ru-men/first-menu.md)中的示例开始修改。

Spigot 不提供上方的鼠标、图片、动画、提示框及模板设置。使用示例时应确认功能符合[Spigot 功能限制](https://simple.superiormc.cn/arcmenu-wen-dang/pei-zhi-yu-guan-li/pages/WTHrY18aDjS0acrYGoiM#spigot-功能限制)。

Spigot 与 Paper 系服务端使用相同的语言设置，具体步骤见[语言管理](/arcmenu-wen-dang/gong-neng-pei-zhi/languages.md)。菜单标题、按钮文字和自定义消息在菜单文件中修改。

## 配置修改流程

1. 备份需要修改的文件。
2. 使用支持 UTF-8 的文本编辑器修改配置，保持 YAML 缩进。
3. 修改菜单后，执行 `/arcmenu validate` 检查配置。
4. 根据上表执行对应的重载命令。
5. 重新打开菜单，检查显示内容和点击操作。

{% hint style="info" %}
配置检查和重载需要 `arcmenu.admin`，默认授予 OP。重载成功后，当前打开的菜单会关闭。出现错误时，应先修正配置，再重新加载。
{% endhint %}

资源包更新还需要让玩家加载新资源包；更换插件 `.jar` 文件则需要重启服务端。

## 下一步

完整的命令用法与权限要求见[命令与权限](/arcmenu-wen-dang/pei-zhi-yu-guan-li/commands-permissions.md)。