# RewardPlugin
**RewardPlugin** 是一个 PaperMC 1.21+ 插件,允许服务器管理员为玩家创建自定义奖励。有一个秘密,这对失业玩家来说是最好的 😉
- 支持 **Vault** 进行经济,**LuckPerms** 进行等级,并提供一种简单的 **基于命令的奖励系统**。
---
**功能**
* 创建给予 **金钱** 或 **等级** 的奖励。
* 在 `data.yml` 中跟踪奖励。
* 简单的命令,权限为 `rpl4z.staff`。
* 在 `config.yml` 中完全可配置的前缀和货币符号。
* 支持多种奖励类型:`ADD-MONEY`、`SET-RANK`。
---
**要求**
* Minecraft 1.21+ (PaperMC)
* **Vault** 插件(用于经济)
* **LuckPerms** 插件(用于等级)
* Java 17+
---
**安装**
1. 下载编译后的 jar 文件。
2. 将其放在 `plugins/` 文件夹中。
3. 启动服务器以生成默认的 `config.yml` 和 `data.yml`。
4. 可选地配置 `config.yml` (可选) 以设置前缀和货币符号。
---
**配置**
**config.yml**
```yaml
prefix: "&6[RewardPlugin] &f"
currency-symbol: "$"
default-rank: "member"
```
* `prefix`: 消息前显示的标记。
* `currency-symbol`: 金钱奖励使用的符号。
* `default-rank`: 用于新等级奖励的默认等级。
**data.yml**
自动存储奖励。例如:
```yaml
rewards:
1:
name: "Mine 100 Diamond"
description: "Reward for mining 100 diamonds"
action: "ADD-MONEY"
requirement: "mine_block"
details:
type: "DIAMOND_ORE"
amount: 100
```
> 除非您知道自己在做什么,否则 **请勿手动编辑** `data.yml`。请使用命令代替。
---
**命令**
所有命令都需要 **权限 `rpl4z.staff`** 或 OP 权限。
**1. 创建奖励**
```
/new-reward
```
* `Name`: 奖励名称。
* `Description`: 奖励的简短描述。
* `Action`: `ADD-MONEY` 或 `SET-RANK`。
* `Requirement`: 奖励触发的方式(例如,`mine_block`、`xp_level`)。
* `Details`: 其他信息(例如,`DIAMOND_ORE:100` 或 `rankname`)。
* `ID`: 此奖励的唯一标识符。
**示例:**
```
/new-reward DiamondReward "Mine 100 diamonds" ADD-MONEY mine_block DIAMOND_ORE:100 1
```
---
**2. 删除奖励**
```
/delete-reward
```
删除具有给定 ID 的奖励。
**示例:**
```
/delete-reward 1
```
---
**3. 编辑奖励**
```
/edit-reward
```
目前作为一个占位符。未来的更新将允许直接修改奖励。
---
**权限**
* `rpl4z.staff` — 访问创建、删除和编辑奖励。
---
**经济 & 等级**
* **金钱**: 需要 Vault 和支持的经济插件(如 EssentialsX、iConomy)。
* **等级**: 需要 LuckPerms。 您可以使用 `SET-RANK` 操作来给予玩家等级。
---
**注意**
* 奖励存储在 `data.yml` 中。除非必要,否则请勿手动删除行。
* 确保您的奖励 ID 是唯一的。
* 该插件会自动与 Vault 和 LuckPerms 集成,无需额外设置。