> For the complete documentation index, see [llms.txt](https://spintowin.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/ji-ben-xin-xi/chu-ci-shi-yong.md).

# 🛠️配置文件

插件会在数据目录中生成下列文件和文件夹；部分文件只有首次使用对应功能后才会生成。

| 路径                          | 用途                                                                                                                       |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `ui/`                       | 转盘 UI 配置                                                                                                                 |
| `item/`                     | 自定义保存物品，见[保存物品](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/gong-neng/saved-item.md)                             |
| `language/`                 | 语言文件                                                                                                                     |
| `pack/`                     | 插件自动生成的资源包                                                                                                               |
| `texture/`                  | 转盘外框和图标的源材质                                                                                                              |
| `generated-item-format.yml` | 执行 `/s2w generateitemformat` 后，保存从手持物品解析出的物品格式                                                                           |
| `XX_xx.json`                | [本地化物品名称](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/gong-neng/localized-item-name.md)生成的游戏语言文件，例如 `zh_cn.json` |

使用默认外框和图标时，无需手动修改源材质；客户端仍需要加载资源包。

## Config.yml

下面的示例与英文文档中的配置结构保持一致。配置项可能随插件版本调整，请以所用版本实际生成的 `config.yml` 为准。

```yaml
# SpinToWin by @rzt1020 & @PQguanfang
#
# READ THE WIKI: spintowin.superiormc.cn
#

config-files:
  language: english
  minecraft-locate-file:
    # 启用后，在需要物品本地化名称时自动加载 Minecraft 语言文件。
    # 文件较大，首次加载时可能出现短暂延迟。
    enabled: true
    generate-new-one: false
    file: 'zh_cn.json'

# 仅 Paper 可用的功能。
paper-api:
  save-item: true
  skull: true
  use-component:
    gui-title: false
    message: false

check-permission-limit: false

# 物品价格
item-price:
  # 可选值：Bukkit、ItemFormat。
  check-method: Bukkit
  item-format:
    ignore-key:
      - 'lore'
      - 'damage'
      - 'tool.damage-per-block'

# 可选值：UUID、Name。
data-save-mode: UUID

math:
  enabled: true

spin-ui:
  add-lore:
    # true 表示将附加 Lore 放在开头。
    # false 表示将附加 Lore 放在末尾。
    at-first-or-last: false
    common-reward:
      - '&7Rate: %rate%%'
    last-reward:
      - '&3(Will obtain if all rewards have claimed!)'
  # 设为 -1 可禁用冷却。
  spin-button-cooldown: 20
  can-not-close-when-spinning: false

auto-copy-resourcepack:
  enabled: true
  # 使用 Oraxen 时，将插件名改为 Oraxen。
  # 其他资源包插件也可用，需要填写正确的目标路径。
  plugin: "ItemsAdder"
  # 使用 Oraxen 时，将路径改为 "/pack/assets"。
  path: "/contents/spintowin/resourcepack/"

mysql:
  enabled: false
  host: localhost
  port: 3306
  user: root
  pass: root
  database: data

# 仅本地数据可用。
auto-save:
  enabled: false
  period-tick: 6000
  hide-message: false
```

* `config-files`：插件语言和 Minecraft 物品名称本地化设置。
* `paper-api`：Paper 专用物品保存、头颅和文本组件功能。
* `check-permission-limit`：启用转盘抽奖次数限制。
* `item-price`：物品价格匹配方式，详见[自定义物品匹配](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/gong-neng/custom-item-match-method.md)。
* `data-save-mode`：玩家数据使用 UUID 或名称作为标识。
* `math.enabled`：数学表达式处理。
* `spin-ui`：奖励附加 Lore、按钮冷却及抽奖时能否关闭界面。
* `auto-copy-resourcepack`：将资源包复制到其他插件目录，详见[自动复制资源包](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/gong-neng/auto-copy-resource-pack.md)。
* `mysql`、`auto-save`：英文配置示例中的数据库与自动保存设置；配置具体版本时请核对实际生成文件。

语言设置见下方说明，UI、奖励和价格分别见[UI 配置](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/zhuan-pan-ui/ui-pei-zhi.md)、[奖励配置](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/zhuan-pan-ui/ui-pei-zhi/jiang-li-pei-zhi.md)和[价格配置](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/zhuan-pan-ui/ui-pei-zhi/jia-ge-pei-zhi.md)。

## 语言文件

语言文件位于 `plugins/SpinToWin/language/`，例如 `zh_CN.yml` 和 `en_US.yml`。

### 选择语言

在 `config.yml` 中设置：

```yaml
config-files:
  language: zh_CN
  per-player-language: true
```

`language` 指定默认语言，`per-player-language` 控制是否按玩家语言选择翻译。修改语言文件后执行 `/s2w reload`。

### 语言文件结构

* `error`：错误提示。
* `help`：帮助文本，可以使用 YAML 多行字符串。
* `gui`：最后赏领取时的标题等界面提示。
* `plugin`：重载、保存物品、重置等操作提示。
* `placeholder`：抽奖按钮状态及价格等变量的默认文本。
* `override-lang`：供配置中的 `{lang:键名}` 使用的翻译内容。

例如：

```yaml
placeholder:
  default-price: "%display% x%amount%"
  click-true: "&e点击开始转盘！"
  click-price-not-meet: "&c你没有足够的金钱或经验值！"
  click-condition-not-meet: "&c条件不满足！"
  click-limit-reached: "&c你已达到该转盘 UI 的最大限制！"

override-lang:
  spin_button: "&a开始抽奖！"
  price_free: "免费"
```

UI 配置可以使用 `name: "{lang:spin_button}"` 引用对应翻译。颜色语法见[颜色代码](https://spintowin.superiormc.cn/jian-ti-zhong-wen-2/gong-neng/color-code.md)，可用变量见[内置变量符](https://spintowin.superiormc.cn/pages/gAxRZB8ZgR1X1jEB77yB#%E6%8C%89%E9%92%AE%E5%A5%96%E5%8A%B1%E4%B8%8E%E6%8F%90%E7%A4%BA%E5%8F%98%E9%87%8F)。

完整语言文件以当前插件实际生成的内容为准，修改时保留需要的键名和变量。
