> For the complete documentation index, see [llms.txt](https://enchantedmobs.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://enchantedmobs.superiormc.cn/ultimatequest-zhong-wen-wen-dang/cai-dan/menus/builtin-options.md).

# 内置菜单选项

本页按 plugins/UltimateQuest/menus/ 中的文件说明。[ItemFormat](/ultimatequest-zhong-wen-wen-dang/gong-gong-ge-shi/itemformat-tm.md) 控制显示物品，[自由菜单配置](/ultimatequest-zhong-wen-wen-dang/cai-dan/menus-1.md) 定义公共布局与动作格式。

## `main.yml：普通任务`

打开命令：`/uq`.

| 选项                     | 说明                                  |
| ---------------------- | ----------------------------------- |
| `enabled / permission` | 启用与打开权限，默认包权限为 ultimatequest.use。   |
| `title / layout`       | 标题与 1–6 行、每行 9 个符号布局。               |
| `category-filter`      | 分类选择配置，继承 config.yml category-menu。 |
| `contents.<symbol>`    | 下列动态内容区。                            |
| `items.<symbol>`       | 静态按钮、状态/视图外观与点击动作。                  |
| `view-filter`          | 筛选顺序/选项，见下方筛选说明。                    |

### 动态内容区

| 符号  | 类型       | 视图/轨道      | 用途           |
| --- | -------- | ---------- | ------------ |
| `Q` | `quests` | always / — | 普通任务定义与已接取实例 |

### 配置节选

```yaml
layout:
- FFFFSFFFF
- FQQQQQQQF
- FQQQQQQQF
- FQQQQQQQF
- FBFTFMFWF
- PKFVCRFFN
view-filter:
  values:
  - ALL
  - ACTIVE
  - AVAILABLE
  - CLAIMABLE
  - CLAIMED
category-filter:
  enabled: true
  hide-empty: true
contents:
  Q:
    type: quests
    filterable: true
    sort: actionable
    use-quest-icon: true
    include: []
    exclude: []
    categories: []
```

默认左键通过 quest 接取/领奖/查看，右键通过 abandon\_quest 发起二次确认。前置任务领奖后解锁后续。AVAILABLE 是浏览状态，不代表所有接取检查必定通过。

## `period.yml：周期任务`

打开命令：`/uq period`.

| 选项                     | 说明                                  |
| ---------------------- | ----------------------------------- |
| `enabled / permission` | 启用与打开权限，默认包权限为 ultimatequest.use。   |
| `title / layout`       | 标题与 1–6 行、每行 9 个符号布局。               |
| `category-filter`      | 分类选择配置，继承 config.yml category-menu。 |
| `contents.<symbol>`    | 下列动态内容区。                            |
| `items.<symbol>`       | 静态按钮、状态/视图外观与点击动作。                  |
| `period-filter`        | 筛选顺序/选项，见下方筛选说明。                    |

### 动态内容区

| 符号  | 类型       | 视图/轨道      | 用途      |
| --- | -------- | ---------- | ------- |
| `Q` | `period` | always / — | 已分配周期实例 |

### 配置节选

```yaml
layout:
- FFFFSFFFF
- FQQQQQQQF
- FQQQQQQQF
- FQQQQQQQF
- PKVHCRFFN
period-filter:
  enabled: true
category-filter:
  enabled: true
  hide-empty: true
contents:
  Q:
    type: period
    filterable: true
    categories: []
    sort: actionable
    use-quest-icon: true
    include: []
    exclude: []
```

period-filter 按周期配置 ID 分组，不是任务分类。固定白名单只含可用 ID 加 all；省略时优先 daily/weekly/monthly，再列其余定义/已分配分组。使用 cycle\_period\_group/set\_period\_group，period-items. 覆盖分组按钮，{period-id}/{period-group} 显示当前 ID/名称。

## `scroll.yml：携带卷轴`

打开命令：`/uq scroll`.

| 选项                     | 说明                                  |
| ---------------------- | ----------------------------------- |
| `enabled / permission` | 启用与打开权限，默认包权限为 ultimatequest.use。   |
| `title / layout`       | 标题与 1–6 行、每行 9 个符号布局。               |
| `category-filter`      | 分类选择配置，继承 config.yml category-menu。 |
| `contents.<symbol>`    | 下列动态内容区。                            |
| `items.<symbol>`       | 静态按钮、状态/视图外观与点击动作。                  |
| `view-filter`          | 筛选顺序/选项，见下方筛选说明。                    |
| `scroll-filter`        | 筛选顺序/选项，见下方筛选说明。                    |

### 动态内容区

| 符号  | 类型       | 视图/轨道      | 用途     |
| --- | -------- | ---------- | ------ |
| `Q` | `scroll` | always / — | 携带卷轴实例 |

### 配置节选

```yaml
layout:
- FFFFSFFFF
- FQQQQQQQF
- FQQQQQQQF
- FQQQQQQQF
- PKVHCRTFN
view-filter:
  values:
  - ALL
  - ACTIVE
  - CLAIMABLE
scroll-filter:
  enabled: true
category-filter:
  enabled: true
  hide-empty: true
contents:
  Q:
    type: scroll
    filterable: true
    categories: []
    sort: actionable
    use-quest-icon: true
    include: []
    exclude: []
```

scroll-filter 按卷轴配置 ID 分组，默认优先 novice/mining/adventure/veteran，再列其他定义/已分配配置。使用 cycle\_scroll\_group/set\_scroll\_group，可配 groups 白名单；scroll-items. 覆盖按钮，{scroll-id}/{scroll-group} 显示配置 ID/名称。显示卷轴领奖时仍检查令牌、归属、时限与奖励。

## `battlepass.yml：战令目录、轨道与挑战`

打开命令：`/uq battlepass [id]`.

| 选项                                   | 说明                                  |
| ------------------------------------ | ----------------------------------- |
| `enabled / permission`               | 启用与打开权限，默认包权限为 ultimatequest.use。   |
| `catalog-title / catalog-layout`     | 未选定义时目录标题/布局。                       |
| `detail-title / detail-layout`       | 选中成长与奖励阶段的标题/布局。                    |
| `challenge-title / challenge-layout` | 挑战视图，未设标题时回退 title/默认值。             |
| `category-filter`                    | 分类选择配置，继承 config.yml category-menu。 |
| `contents.<symbol>`                  | 下列动态内容区。                            |
| `items.<symbol>`                     | 静态按钮、状态/视图外观与点击动作。                  |

### 动态内容区

| 符号  | 类型           | 视图/轨道            | 用途        |
| --- | ------------ | ---------------- | --------- |
| `J` | `challenge`  | challenges / —   | 选中战令/赛季挑战 |
| `A` | `battlepass` | catalog / —      | 战令目录或阶段奖励 |
| `Q` | `battlepass` | detail / free    | 战令目录或阶段奖励 |
| `L` | `battlepass` | detail / free    | 战令目录或阶段奖励 |
| `R` | `battlepass` | detail / premium | 战令目录或阶段奖励 |

### 配置节选

```yaml
catalog-layout:
- FFFFSFFFF
- FAAAAAAAF
- FAAAAAAAF
- FAAAAAAAF
- PKFHCXFFN
detail-layout:
- FFFFDFFFF
- FQQQQQQQF
- FLLLLLLLF
- FRRRRRRRF
- PIFBCXFGN
challenge-layout:
- FFFFDFFFF
- FJJJJJJJF
- FJJJJJJJF
- FJJJJJJJF
- PKYBCXFVN
category-filter:
  enabled: true
  hide-empty: true
contents:
  J:
    display: challenges
    type: challenge
    filterable: true
    categories: []
    sort: actionable
    use-quest-icon: true
  A:
    display: catalog
    type: battlepass
    sort: actionable
    use-quest-icon: true
    include: []
    exclude: []
  Q:
    display: detail
    type: battlepass
    track: free
    sort: natural
    use-quest-icon: false
  L:
    display: detail
    type: battlepass
    track: free
    sort: natural
    use-quest-icon: false
  R:
    display: detail
    type: battlepass
    track: premium
    sort: natural
    use-quest-icon: false
```

目录卡使用 catalog-item，选中阶段用 state-items.<状态>，缺省回退 item。track 筛选阶段 ID，不控制挑战准入。{level}/{total}/{required}/{track}/{rewards} 描述阶段，free/premium/default 为内部轨道标识。

open\_challenges 或 /uq battlepass challenges 打开挑战，cycle\_challenge\_group 筛选 ALL/DAILY/WEEKLY/SEASON。挑战积分自动结算，claim\_all 操作等级奖励。

## `milestone.yml：里程碑目录与阶段`

打开命令：`/uq milestone [id]`.

| 选项                               | 说明                                  |
| -------------------------------- | ----------------------------------- |
| `enabled / permission`           | 启用与打开权限，默认包权限为 ultimatequest.use。   |
| `catalog-title / catalog-layout` | 未选定义时目录标题/布局。                       |
| `detail-title / detail-layout`   | 选中成长与奖励阶段的标题/布局。                    |
| `category-filter`                | 分类选择配置，继承 config.yml category-menu。 |
| `contents.<symbol>`              | 下列动态内容区。                            |
| `items.<symbol>`                 | 静态按钮、状态/视图外观与点击动作。                  |

### 动态内容区

| 符号  | 类型          | 视图/轨道            | 用途         |
| --- | ----------- | ---------------- | ---------- |
| `A` | `milestone` | catalog / —      | 里程碑目录或阶段奖励 |
| `L` | `milestone` | detail / default | 里程碑目录或阶段奖励 |

### 配置节选

```yaml
catalog-layout:
- FFFFSFFFF
- FAAAAAAAF
- FAAAAAAAF
- FAAAAAAAF
- PKFHCRFFN
detail-layout:
- FFFFDFFFF
- FLLLLLLLF
- FLLLLLLLF
- PFFBCRFFN
category-filter:
  enabled: true
  hide-empty: true
contents:
  A:
    display: catalog
    type: milestone
    categories: []
    sort: actionable
    use-quest-icon: true
    include: []
    exclude: []
  L:
    display: detail
    type: milestone
    track: default
    sort: natural
    use-quest-icon: false
```

目录卡使用 catalog-item，选中阶段用 state-items.<状态>，缺省回退 item。track 筛选阶段 ID，不控制挑战准入。{level}/{total}/{required}/{track}/{rewards} 描述阶段，free/premium/default 为内部轨道标识。

## `settings.yml`: 公共设置

```yaml
anti-dupe-checker: true
lore-wrap-length: 34
progress-bar:
  length: 12
  complete: '{lang:defaults.ui.progress-bar.complete}'
  remaining: '{lang:defaults.ui.progress-bar.remaining}'
  suffix: '{lang:defaults.ui.progress-bar.suffix}'
```

settings 不是可打开菜单。anti-dupe-checker 控制 GUI 防复制，lore-wrap-length 控制 lore 换行，progress-bar.length/complete/remaining/suffix 控制进度条。这些放在 menus/settings.yml，内部通过 menu.\* 配置命名空间读取。

## 状态视图

view-filter.values 接受 ALL、ACTIVE、AVAILABLE、COMPLETED、CLAIMABLE、CLAIMED、LOCKED、INACTIVE，去重合法值并控制 cycle\_view 顺序。无合法覆盖时，scroll 默认 ALL/ACTIVE/CLAIMABLE，period/挑战默认 ALL/ACTIVE/CLAIMABLE/CLAIMED，其他默认 ALL/ACTIVE/AVAILABLE/COMPLETED。

AVAILABLE 含未接取 AVAILABLE/LOCKED；COMPLETED 含完成/领奖中/已领奖/待复核；CLAIMABLE 含完成任务或可领取阶段；CLAIMED 只含已领奖；LOCKED 含需高级资格阶段。可与分类/配置分组组合。category-filter.hide-empty 隐藏数量为零分类，默认 false，默认包 main/scroll 开启。

## 物品变量

| 范围    | 变量                                                                                                                                                                                                                                                             |
| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 公共    | `{player}`, `{menu}`, `{page}`, `{pages}`, `{view}`, `{count}`, `{active}`, `{claimable}`, `{claimed}`, `{available}`, `{locked}`, `{category-id}`, `{category-name}`, `{challenge-group}`, `{period-id}`, `{period-group}`, `{scroll-id}`, `{scroll-group}`   |
| 任务/阶段 | `{id}`, `{name}`, `{description}`, `{objectives}`, `{state}`, `{hint}`, `{prerequisites}`, `{categories}`, `{level}`, `{total}`, `{required}`, `{progress}`, `{progress-required}`, `{progress-percent}`, `{progress-bar}`, `{track}`, `{season}`, `{rewards}` |
| 分配信息  | `{rarity}`, `{difficulty}`, `{points}`, `{group}`, `{unlock-week}`, `{source}`, `{expires}`, `{expires-in}`                                                                                                                                                    |
| 选中成长  | `{next-required}`, `{remaining-xp}`, `{season-time}`                                                                                                                                                                                                           |

description/objectives/rewards 宜分别放独立 lore 行以展开多行，条目变量覆盖菜单汇总值。分类卡变量见[分类](/ultimatequest-zhong-wen-wen-dang/pei-zhi/categories.md)，点击绑定见[菜单动作](/ultimatequest-zhong-wen-wen-dang/cai-dan/menus/actions.md)，完整类型见[动作参考](/ultimatequest-zhong-wen-wen-dang/pei-zhi/actions.md)。
