Java 插件文档

### 适用版本
1.7 - 26.x

### 适用核心
`Bukkit` `Spigot` `Paper` `Folia`
`CatServer` `Mohist` `Uranium` `Arclight`
以及任何其他 `Paper 分支`

#### 暂不兼容
`Thermos 1.7.X` `Fabric`

### 注意事项
请勿使用 `Yum` 或 `Plugman` 等热加载此插件
应当放入 `plugins` 文件夹并重启服务器使用

### 插件命令
```
/minepay buy <礼包名> 购买指定礼包
/minepay buy <充值金额> <支付方式> 购买指定礼包
/minepay point <充值金额> 购买指定点券
/minepay point <充值金额> <支付方式> 购买指定点券
<支付方式> 微信:wechat 支付宝:alipay

/minepay log 查询充值记录
/minepay log <玩家名> 查询玩家充值记录
/minepay top 查询玩家充值排行榜
/minepay gui 打开礼包充值菜单
/minepay reward 打开累计奖励菜单
/minepay reward <奖励名> 领取累计奖励

/minepay ip 输出服务器 IP 信息
/minepay reload 重载配置文件
/minepay update 在线更新插件
/minepay consume add <玩家名> <金额> 增加玩家累计金额
/minepay consume sub <玩家名> <金额> 减少玩家累计金额
/minepay consume set <玩家名> <金额> 设置玩家累计金额
/minepay diagnosis 网络服务诊断
/minepay sync 同步本地数据到数据库
/minepay ip 输出服务器 IP 信息
```

### 权限配置
```
玩家权限
minepay.user.help
minepay.user.log
minepay.user.gui
minepay.user.buy
minepay.user.point
minepay.user.reward
minepay.user.top

管理权限
minepay.admin.log
minepay.admin.reload
minepay.admin.update
minepay.admin.notice
minepay.admin.dev
minepay.admin.debug
minepay.admin.http
minepay.admin.consume
minepay.admin.diagnosis
minepay.admin.sync
minepay.admin.ip
minepay.admin.bc
```

### Papi 变量
```
%minepay_consume% 玩家累计充值金额
%minepay_top1% 服务器充值排行榜
%minepay_top2%
......
%minepay_top10%
```

### config.yml
```yaml
# 服务器令牌
# 前往官网注册后
# 添加服务器获得
token: 'xxxxxxxxxx'

# 是否启用微信支付
wechat: true
# 是否启用支付宝支付
alipay: true

# 是否启用异常日志上报（求别关闭，这对我们修复 bug 很重要的/(ㄒoㄒ)/~~）
# 提示：这个是不会发送敏感信息的，只会上报没有被捕获的 MinePay 异常
log-report: true

# 当前有人正在支付时,无法创建价格相同订单
# 关闭状态下会创建价格相同订单多0.01元
# 避免若玩家没注意到实际付款金额差异问题
line: false

# 下单成功给玩家显示标题
show-title: true

# 是否开启网页购买
# 若不需要网页下单购买
# 请关闭以节省宽带资源
web-shop: true

# 查询订单发货时间间隔 单位:秒
# 若宽带足够可适当调低提高到账速度
check-time: 3

# 是否开启公告
# 管理员会收到 MinePay 最新消息
# 我们承诺不会利用公告来展示广告
notice: true

# 若与龙核模组冲突导致无法显示地图
# 请打开此选项下单自动取消副手物品
off-hand: false

# 订单延时取消时间（单位：秒）
# 为了避免玩家充值时掉线或主动取消订单
# 导致玩家付款后订单在发货前被过早取消
# 如果没有以下情况强烈推荐保持默认十秒
# 由于您服务器使用了Geyser支持手机端
# 那么玩家在下单之后支付时大概率掉线
# 可以在不影响正常订单下酌情调大一些
delay-cancel: 10

# 禁用其他拦截插件联网插件
disable-network-manager-plugin: true

# 在你的机器出现 SSL 证书问题的时候
# 可以使用传统的 HTTP 协议
# 默认不建议开启，除非你的网络是可信的
use-http: true

# 是否启用高级网络特性
# 禁用后将会失去以下功能:
# 1. 自动重试
# 2. 线路切换
enable-hyper-network-feature: true

# 延迟离线发货时间（单位：秒）
# 为了避免玩家进入服务器背包同步前发货
# 若没有背包同步插件请保持默认关闭即可
delay-offline-deliver: 0
```

### point.yml
```yaml
# 点券比例
# 充值一元玩家得到多少点券
# 比例设置为 0 关闭点券充值
# 可用变量：%player% 玩家名字
#         %point% 点券数量
#         %money% 充值金额
point-count: 100
point-name: '点券'
point-command:
- 'points give %player% %point%'
- 'say %player% 购买了 %point% 点券'

```

### kit.yml
```yaml
# 礼包名字
测试金币:
  # 充值金额(整数)
  price: 10
  # 菜单显示物品
  material: APPLE
  # 菜单排序(数值越小越靠前)
  sort: 1
  # 是否允许玩家离线时发货
  offline: false
  # 每人是否只能充值一次
  novice: false
  # 需要该权限才能购买(默认拥有)
  permission: 'minepay.user.buy'
  # 是否同步到网页购买
  web: true
  # 菜单显示介绍
  lore:
  - '这是商品介绍第一行'
  - '这是商品介绍第二行'
  # 充值成功后执行指令
  command:
  - eco give %player% 100
  - say %player% 购买了金币

首充礼包:
  price: 1
  material: ARROW
  sort: 2
  offline: false
  novice: true
  web: true
  lore:
  - '这个是首充礼包'
  - '每人仅能买一次'
  command:
  - eco give %player% 100
  - say %player% 购买了首充礼包
```

### reward.yml
```yaml
# 累计充值奖励 (非必要)

# 奖励名字
测试奖励1:
  # 玩家充值金额累计达到多少才能领取
  price: 8888
  # 菜单显示物品
  material: APPLE
  # 菜单排序(数值越小越靠前)
  sort: 1
  # 需要该权限才能领取
  # 玩家默认拥有 minepay.user.reward
  permission: 'minepay.user.reward'
  # 菜单显示介绍
  lore:
    - '这是奖励介绍第一行'
    - '这是奖励介绍第二行'
  # 领取成功后执行指令
  command:
    - 'give %player% stone 64'
    - 'say %player% 累计充值了8888元，获得奖励'

测试奖励2:
  price: 9999
  material: APPLE
  sort: 2
  permission: 'minepay.user.reward'
  lore:
    - '这是奖励介绍第一行'
    - '这是奖励介绍第二行'
  command:
    - 'give %player% diamond 64'
    - 'say %player% 累计充值了9999元，获得奖励
```

### mysql.yml
```yaml
# 如果启用 MySQL 那么在此配置
# 支持 MySQL 版本 5.7 ~ 8
# 使用支持以外的版本会导致异常

# 启用
enabled: false
# 地址
host: 127.0.0.1
# 端口
port: 3306
# 库名
database: minepay
# 账号
user: root
# 密码
password: password
# 加密连接
use-ssl: false
```

### server-tokens.yml
```yaml
# API 接口令牌（可选，BC 服建议使用）
# 请前往官网，查看插件文档，文档里有使用方法
# 直达文档链接 https://ln.minepay.top/U6PgGx
api-token: ''
```

### bc-config.yml
```yaml
# 是否启用配置文件拉取功能
# 用于 BC 下配置文件同步
# 如果开启必须配置 mysql.yml
enabled: false

# 拉取配置文件的间隔时间（单位：秒）
# 最低间隔时间为 2 秒
pull-interval: 2

# 拉取配置文件后是否自动重载
auto-reload: true

# 需要同步的配置文件
sync-files:
  - config.yml
  - kit.yml
  - point.yml
  - reward.yml
  - lang.yml
  - server-tokens.yml

```