¶ 插件简介
- 可自定义创建多个道馆
插件自带模板拥有18个属性道馆以及道馆挑战要求 - 所有道馆单独设置
对战规则、禁用精灵、禁用携带物、精灵要求、携带称号、徽章物品 - 所有道馆单独设置
成为馆主、馆主卸任、每日奖励命令 - 插件所有
语言文本、插件界面格局、界面展示物品均可自定义 - 道馆拥有等级系统，可在配置文件设置每个等级所需经验值（可配合附属使用）
- 可设置馆主在被挑战的情况下超时多久不接受挑战
自动取消馆主身份，可在配置文件关闭此功能 - 可在配置文件中设置
馆主战败多少次取消馆主、玩家每天挑战次数、馆主每天可以拒绝玩家挑战次数 - 可设置玩家与馆主战斗是否
强制使用上传精灵进行对战 - 可自定义对战完成后的
战胜馆主、战败馆主、平局执行命令 (可用于扣除或增加或给予奖励) - 插件自带积分系统，可在配置文件自定义积分展示名称以及设置
挑战馆主、申请馆主、馆主重新上传队伍所需积分 - 馆主申请、挑战者挑战道馆可设置
自动审核和手动审核
手动审核：
上传者上传背包精灵并扣除相应的积分，由拥有XinxinPokeGym.audit权限的玩家发送/xpg open admin进行手动审核自动审核：
上传者上传背包精灵，会自动根据当前道馆设置规则审核通过后将会扣除所需积分并上传精灵
¶ 核心兼容
插件只在下列核心进行测试，正常使用，其它服务端核心未知，请自行测试。
1.12.2版本：CatServer
1.16.5版本：CatServer
1.20.2版本：arclight
已测试重铸宝可梦版本 8.4.3、9.1.11、9.2.8
¶ 前置插件
¶ 授权与验证
获取到授权码过后请添加所有的前置插件并加载一次插件
将授权码填写至插件文件夹中的 key.yml 文件内并重启服务器即可正常加载插件
key: "填写你的授权码"
¶ 指令权限&介绍
玩家基础指令:
/xpg open 界面类型 — 打开精灵道馆界面
/xpg setspawn [道馆] — 设置某道馆据点（只有成为馆主才拥有权限）
界面类型可填：
main=插件主页 apply=查看申请进度 gym=道馆选择页面 manage=道馆管理页面
admin=管理员审核页面（所需权限：XinxinPokeGym.audit）
管理员指令介绍（权限：XinxinPokeGym.admin）
/xpg remove [道馆] — 删除某道馆馆主
/xpg give [玩家] [道馆] — 给予玩家某道馆勋章
/xpg add [玩家] [数量] — 增加玩家道馆积分
/xpg take [玩家] [数量] — 扣除玩家道馆积分
/xpg set [玩家] [数量] — 设置玩家道馆积分
/xpg expadd [道馆] [数量] — 增加道馆经验值
/xpg expdel [道馆] [数量] — 扣除道馆经验值
/xpg reset [玩家名] <备份编号> — 手动恢复玩家备份数据
注：备份编号不写则是恢复最近的一次备份数据，如果有特殊需求可以按照玩家数据文件内的备份编号填写
/xpg reload — 重载插件
¶ 插件变量
XinxinPokeGym_prefix% — 获取玩家当前佩戴道馆称号
XinxinPokeGym_points% — 获取玩家道馆积分
XinxinPokeGym_level_道馆名称% — 获取道馆等级
XinxinPokeGym_exp_道馆名称% — 获取道馆经验值
XinxinPokeGym_maxexp_道馆名称% — 获取升级所需经验值
XinxinPokeGym_masterp_道馆名称% — 获取当前道馆馆主
¶ 默认文件介绍
我们将插件加入服务器并填写好key后启动会生成下列文件
默认生成的配置是1.12.2版本的，高版本默认配置可在插件下载页面下载获取
Data此文件夹用于存放插件数据(可无视)
- PlayerData 文件夹存放玩家数据
- ApplyData.yml 存放玩家申请道馆数据
- GymData.yml 存放道馆数据
config.yml是插件的全局核心配置gui.yml是插件界面设置文件，可在这个文件自定义插件界面以及展示物品gyms.yml道馆基础设置文件，默认自带18个属性道馆可在这里设置道馆基本配置key.yml用于存放用户验证码文件lang.yml插件的语言提示文件，可自定义插件提示语rules.yml规则数据文件，可在这里自定义规则用于限制玩家申请以及挑战
¶ 插件配置介绍
以下是插件各个文件如何配置的使用方法
展示版本为3.0.1-SNAPSHOT
¶ config.yml文件配置及介绍
当我们正常加载插件后应该会生成一个 config.yml 文件默认自带下方内容
在这个文件内我们可以根据其中的 中文注释 设置道馆的基础配置
#道馆的一些设置
GymData:
#玩家查看道馆时是否可以查看馆主精灵属性
LookPoke: false
#是否开启馆主自动审核(开启自动审核玩家需要精灵达到要求才会扣除积分)
#如果不开启自动审核玩家每次发起申请都会扣除积分
AutoExamine: true
#馆主超时不接受战斗自动取消馆主身份，单位小时 （设置为0则不启用此功能）
AutoRemoveMaster: 48
LevelSet:
#道馆每个等级所需经验值
Levels:
1: 100
2: 200
3: 300
4: 400
5: 500
BattleSet:
#馆主失败多少次取消资格 （设置为0则不取消）
FailedRemoveNum: 5
#玩家每天可以挑战总次数 （设置0则不限制）
DayBattleNum: 3
#馆主每天可以拒绝次数 （设置0则不限制）
GymDayRejections: 3
#玩家是否可以重复战胜道馆
GymOvercome: false
#馆主是否只能用上传精灵进行战斗
GymBattlePoke: true
#挑战者是否只能用发起挑战精灵进行战斗
BattlePoke: true
#馆主接受战斗后多少秒开始战斗
ReadyTime: 3
#准备时屏幕悬浮文字
Title:
Main: "&f%gym% &a馆主已接受挑战"
Sub: "&a-=&c%i%&a=- &a请做好战斗准备 -=&c%i%&a=-"
Main_battle: "&a正在进行 &f%gym% &a道馆对战"
Sub_battle: "&a-= 全神贯注 =-"
#挑战完成后执行指令
BattleCmd:
#战胜馆主执行的指令
#%p1% = 挑战者id %p2% = 馆主id %gym% = 道馆名称
win:
- "broadcast &f%p1% &a战胜了 &f%gym% &a馆主 &f%p2%!"
- "xpg give %p1% %gym%"
#挑战失败执行的指令
lose:
- "broadcast &f%p2% &a没打过 &f%gym% &a馆主 &f%p1%!"
# 增加馆主5点积分
- "xpg add %p1% 5"
# 增加馆主10点经验值
- "xpg expadd %gym% 10"
#平局执行指令
draw:
- "broadcast &f%gym% &a馆主 &f%p1% &a和 &f%p2% &a打成了平局!"
PointsSet:
#分数展示文本
PointsString: "道馆积分"
#挑战所需积分
BattlePoints: 1
#申请馆主所需积分
ApplyPoints: 5
#馆主重新上传精灵所需积分
ReUploadPoints: 5
#道馆数据储存设置
BackupSet:
#玩家队伍信息最大备份数量
MaxBackupNum: 5
#插件数据储存时间间隔(单位秒)
BackupTime: 3600
#道馆检测间隔时间（单位秒）
GymCheckTime: 3600
¶ gyms.yml文件配置及介绍
当我们正常加载插件后应该会生成一个 gyms.yml 文件其中有默认自带的18个属性道馆以及配置
如果要新建一个道馆的话可以根据下方格式在文件中新建
配置文件中的道馆数量不要超过
gui.yml文件界面大小，否则无法在道馆界面正常显示道馆
#这里写道馆名称（也是触发命令或提示语句的关键词）
一般道馆:
#对战规则文本(需要按照教程格式填写，即将弃用，可忽略)
Rules: []
#申请馆主精灵要求，若开启配置项AutoExamine达到要求自动晋升馆主
#要求文件在rules.yml文件配置
Apply_Rules: "一般道馆申请要求"
#玩家挑战精灵要求
#要求文件在rules文件配置
Challenge_Rules: "一般道馆挑战要求"
#道馆馆主显示的称号
Prefix: "&7[&d一般馆主&7]"
#成为馆主执行的命令
InheritReward:
- "broadcast %player%成为了道馆馆主"
#失去馆主执行的命令
LostReward:
- "broadcast %player%失去了馆主资格！"
#馆主每日奖励 （后台执行命令）
DayReward:
- "broadcast %player%领取了一般道馆每日奖励！"
#道馆象征性标志物品
GiveItem:
type: "PIXELMON_BALANCE_BADGE"
data: 0
name: "&6☆ &7一般道馆徽章 &6☆"
lore:
- ""
- " &f ✪ &a象征着实力的徽章"
#设置在gui中显示的图标
GuiItem:
#显示物品id
type: "PIXELMON_BALANCE_BADGE"
#物品子id
data: 0
#物品显示名称
name: "&6☆ &7一般道馆 &6☆"
#已有馆主时显示的lore
HaveLore:
- " &f ✪ &a当前馆主: &e%play%"
- " &f ✪ &a剩余总挑战数: &e%all_number%/3 &a次"
- " &f ✪ &a馆主上线时间: &e%time%"
- ""
- " &f ➥ &6点击进入道馆"
#无馆主时申请的lore
NotLore:
- " &f ▌ &d馆主要求:"
- " &f ✪ &a一般系精灵 × 3"
- " &f ✪ &a精灵数量 × 6"
- " &f ✪ &a6v精灵 × 3"
- " &f ✪ &a满努力值精灵 × 3"
- " &f ✪ &a等级不得低于100级"
- " &f ✪ &a积分 × &f5"
- " &f ▌ &d申请要求:"
- " &f ✪ &c每人 &e24小时 &c只能发起一次申请"
- " &f ✪ &c发起成功后需等待服主审核精灵"
- " &f ✪ &c服主审核成功后便能成为馆主"
- ""
- " &f ➥ &6点击申请馆主"
- " &f ➥ &6右键查看详细申请条件"
¶ rules.yml文件配置及介绍
当我们正常加载插件后应该会生成一个 rules.yml 文件其中有默认自带的18个属性道馆挑战规则和申请馆主规则
在其中可以在 gym.yml 自定义玩家申请道馆 Apply_Rules 和挑战道馆 Challenge_Rules 的要求
如果要新建规则可以按照下方配置格式在文件中自定义
#规则条件名称（也就是在道馆配置中需要填写的关键词）
一般道馆申请要求:
#至少需要多少只宝可梦
PokeAmount: 1
#固定需要哪些宝可梦（填写精灵翻译名如果没汉化则写精灵英文名）
PokeFixed:
- "皮卡丘"
#禁止携带那些宝可梦（填写精灵翻译名如果没汉化则写精灵英文名）
BanPoke:
- "Mew"
- "梦幻"
#禁止携带物
BanItem:
#演示禁用的是气势披带
- "气势披带"
#精灵属性要求
PokeAttribute:
#amount：填写要求需达到的精灵数量
#type：填写要求的类型：
#ivs（个体）、evs（努力值）、level（等级）、type（属性）、OriginalTrainer（需要精灵初始训练师是上传者）
#value：填写要求的值
#ivs：填写要求精灵个体总和至少 >= ?
#evs：填写要求精灵努力值总和至少 >= ?
#level：填写要求精灵等级至少 >= ?
#value：填写要求精灵判断要求
#填写属性英文名首字母大写，可创建多个属性判断进行多个属性要求
#Normal=一般、Fire=火、Water=水、Electric=电、Grass=草、Ice=冰
#Fighting=格斗、Poison=毒、Ground=地面、Flying=飞行、Psychic=超能力
#Bug=虫、Rock=岩石、Ghost=幽灵、Dragon=龙、Dark=恶、Steel=钢、Fairy=妖精
#要求名称，可自定义
精灵个体总和186×3:
amount: 3
type: "ivs"
value: "186"
精灵努力值总和510×3:
amount: 3
type: "evs"
value: "510"
精灵等级100×6:
amount: 6
type: "level"
value: "100"
一般属性精灵×3:
amount: 3
type: "type"
value: "Normal"
初始训练师精灵所需数量:
amount: 3
type: "OriginalTrainer"
value: "0"
