说明
此 wiki 内所使用的文件名及目录名均为默认的，自行替换成你自己的目录及文件名即可。
插件前置
PlaceholderAPI(可选), AyCore
插件激活
将插件放入 plugins 加载一遍生成配置文件，打开 ./plugins/TXZ/config.yml
# 授权服务器Key
key: "在这里输入你的授权码(注意 : 后方有个空格)"
结构说明
在目录 ./plugins/TXZ/ 中，有多个文件和目录，下方是它们的作用说明。
| 文件名 | 文件说明 |
|:----|:----|
|config.yml|配置文件，消息提示, 存储设定, 重置设置|
|time.yml|存储刷新时间|
./TXZ/TxzMain/example 为配置生成的example通行证配置文件
| 文件名 | 文件说明 |
|:----|:----|
|gui.yml|通行证界面配置文件|
|rule.yml| 通行证规则配置文件|
|kits.yml| 通行证奖励配置文件|
指令
给予经验
/txz give <玩家> <通行证名称> <经验数额> <是否比例检测(可选)> <是否事件检测(可选)>#给予玩家通行证经验
<是否比例检测>: 为对应通行证设置中的根据拥有权限获得经验比例设置
<是否事件检测>: 增加经验的限制事件.
(可选): 表示该参数可以省略.
假如render 玩家对应通行证所拥有的权限对应的比例为: 0.01 下面举几个例子:
/txz give render example 1000 false #给予1000点经验
/txz give render 测试通行证 500 BATTLE # 给予500 * 0.01点经验，经过BATTLE经验检测
/txz give render example 600 # 给予600*0.01点经验
增减通行证经验/等级
/txz set/add/reduce <玩家> <通行证名称> exp/level <数额> #设置/增加/减少/设置玩家通行证经验或等级
下面举几个例子:
/txz add render example exp 1000 #增加指定通行证总经验1000点
/txz set render 测试通行证 level 10 #设置指定通行证等级为10级
/txz reduce shawhoi example exp 500 #减少指定通行证的总经验500点
改变总经验值会使等级发生变化，变化范围由对应通行证的等级相关
即玩家经验值没有上限, 玩家的等级有上限
设置玩家会员
/txz giveVip/delVip <玩家> <通行证名称> <会员类型> #给予/取消玩家通行证会员
<会员类型> 为对应通行证容器设置中的会员类型, 如默认容器规则文件rule.yml中的 vip1 与 vip2
同时，不论是否使用该指令, 当玩家拥有对应的rule.yml的会员对应权限的时候，也视为会员
重置限制/数据
/txz rd/reset <通行证名称> <玩家(可选)> #重置通行证的每日经验限制/玩家数据
<玩家>: 如果不指定玩家, 默认就是全部玩家
下面举几个例子:
/txz rd example #重置所有玩家example通行证的每日经验限制
/txz reset example render #重置render玩家的example通行证的数据
重载配置
/txz reload #重载配置
通行证容器
此处借用插件生成的默认配置文件进行举例
文件夹路径: ./plugins/TXZ/TxzMain/example
界面配置
文件路径: ./plugins/TXZ/TxzMain/example/gui.yml
槽位物品展示
# 是否启用额外槽位物品展示
other-show:
# 开启 display 额外展示物品
display: false
get: true
# 无奖励时的槽位物品
display:
type: RED_STAINED_GLASS
lore: []
name: "&c无"
# 领取后的槽位物品设定
get:
type: STONE
lore: []
name: "&c已经领取了"
# 槽位设定
rewardSlot:
# 普通奖励
default: 10,11,12,13,14,15,16
# 会员奖励
vip: 28,29,30,31,32,33,34
# 会员2奖励
vip2: 37,38,39,40,41,42,43
other-show: 是否启用对应的额外物品展示设置
display: 该配置项为 rewardSlot对应的槽位中无奖励设置时的物品展示,
get: 该配置项为领取奖励过后的槽位物品显示设定.
rewardSlot: 该配置项为奖励显示的槽位, 槽位具体展示的物品，会根据 kits.yml (如下所示) 中全部的奖品数量，再根据分页计算, 来显示到界面上面。
基础界面设置
# 界面标题
title: "&8通行证奖励 页码: %page%"
# 界面大小
size: 54
# 点击相关物品会执行命令
itemCommand:
# 点击items中的info物品会执行的命令
info:
- chestcommands open txzhy %player%
# 界面物品设定
items:
info:
type: GOLD_BLOCK
data: 0
name: "&b我的通行证信息"
amount: 1
lore:
- " "
- " &f ▣ &e通行证名称: &f%txzShow% "
- " &f ▣ &e通行证等级: &f%level% "
- " &f ▣ &e升级所需: &f%exp% "
- " &f ▣ &e通行证会员: &f%vip% "
- " "
slot: 49
action: command-info
...
items.xxx.action: 物品的执行变量, 可设置为任意字符串.
item-command: 点击物品会执行命令, 设置方法为在 action 中加入 command- + item-command的节点, 例如 command-info
奖励设置
文件路径: ./plugins/TXZ/example/kits.yml
设定奖励
#奖励等级名(不可重复)
1:
# 对应的权限名
default:
# 显示物品的英文id
id: STONE
data: 0
# 名称
name: "&a一级奖励"
amount: 1
# 描述
lore:
- " "
- "&f* &7石头一个 "
- " "
- "&2➜ %status%"
# 领取后执行的指令
commands:
- "give %player% 1 1"
...
%status%: 该变量会显示该奖励的领取状态，该内容会被替换成 config.yml中message.status 的相应字符串
规则设置
文件路径: ./plugins/TXZ/example/rule.yml
权限
# 玩家默认拥有的权限 (
default-vipType:
- default
# 通行证权限
permission:
default: "all"
vip: "txz.vip"
vip2: "txz.vip2"
不论如何，请保留一个default节点
经验获取
# 经验比例
exp:
default: 0.02
vip: 0.06
vip2: 0.1
# 获得经验事件
# 请保证 所有会员 的事件数量相同
exp-event:
#普通
default:
# 战斗获取经验数
BATTLE: 1000
# 糖果获取经验数
RARE_CANDY: 100
# 下方设定 8.3.6 及以上生效
RARE_SODA: 100
ULTRA_RARE_SODA: 100
EXTRA_SMALL_EXP_CANDY: 100
SMALL_EXP_CANDY: 100
MEDIUM_EXP_CANDY: 100
LARGE_EXP_CANDY: 100
EXTRA_LARGE_EXP_CANDY: 100
CURRY_KOFFING: 100
CURRY_WOBBUFFET: 100
CURRY_MILCERY: 100
CURRY_COPPERAJAH: 100
CURRY_CHARIZARD: 100
通行证经验公式: 玩家在某个事件中获得的经验 * 玩家对应的经验比例
例如: xuan_ran只拥有 default 权限 在 BATTLE(精灵战斗) 事件中, 获得了10000 Exp, 那么它获得的通行证经验 为 10000 * 0.02 = 200 点.
等级
Levels:
1: 3000
2: 3000
3: 3000
4: 3000
5: 3000
6: 3000
...
1:3000 即从0级到1级所需的经验
其他设置
文件路径: ./plugins/TXZ/config.yml
重置设置
# 重置设定
reset:
# 每日经验上限刷新时间
exp: "00:00:00"
# 通行证刷新
txz:
# 时间间隔 (单位: 天)
date: 90
# 指定日期重置
Specify:
- "2024/3/14 00:00:00"
#时间 (重置时间）
time: "00:00:00"
存储设置
# 存储方式, 可选: YAML, MYSQL 默认 YAML
save-option:
type: YAML
# MySQL的URL，例如jdbc:mysql://127.0.0.1/minecraft 格式：jdbc:mysql://MySQL地址/数据库名
url: jdbc:mysql://localhost/minecraft
# 数据库用户名
user: "root"
# 数据库密码
password: "root"
# 数据库读取超时打开数据锁时长, 2 = 1秒
time-out: 120
# 登录数据加载提示
pull-message: true
消息设置
message:
prefix: "&3通行证 &f"
help:
default:
...
admin:
...
papi变量
%txz_txzName_level% 通行证等级%txz_txzName_amount_all% 有多少个奖励可领取%txz_txzName_amount_vipType% 有多少个奖励可领取(指定会员类型)%txz_txzName_need% 还差多少经验升级%txz_txzName_vip% 所拥有的权限 (如果没有则显示: 无)
txzName: 对应通行证的名称
常见问题
如何增加一个容器
复制./plugins/TXZ/TxzMain/example 文件夹于同目录下
然后更改里面的相关设置即可
更改1.12版本默认gui文件
前往./plugins/TXZ/TxzMain/example/gui 文件夹
display:
type: RED_STAINED_GLASS #(将此处修改为 GLASS)
lore: []
name: "&c无"
items:
fg:
type: GLASS_PANE #(将此处修改为 STAINED_GLASS_PANE)
name: "&f"
amount: 1
data: 0
lore: [ ]
slot: 0,1,2,3,4,5,6,7,8,45,47,48,49,50,51,53
fg1:
type: WHITE_STAINED_GLASS_PANE #(将此处修改为 STAINED_GLASS_PANE)
name: "&f"
data: 0 #(将此处修改为 15)
amount: 1
lore: [ ]
slot: 9,17,27,35,36,44
