1.0.0 beta9

.gitignore

@@ -1 +1,15 @@
-target/*
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/*
+
+# Eclipse m2e generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath

docs/SupportPluginsVariables.md

@@ -11,43 +11,22 @@
 ](./SupportPluginsVariables.md)
 # **变量文档(支持的插件)**
 ---
-> **按插件的英文字母排序**  
-> **TipsVeriable 相关变量移值中,部分变量名有改动**
-
-<!-- ## A
+- **按插件的英文字母排序**  
+- **TipsVeriable 相关变量移值中,部分变量名有改动**
 ---
-## B
----
-## C
----
-## D
---- -->
-## **E**
-### **[EconomyAPI](https://github.com/Nukkit-coders/EconomyAPI)**
+## **[EconomyAPI](https://github.com/Nukkit-coders/EconomyAPI)**
 |变量名|变量介绍|
 |:-:|:-:|
 |{economyApi-money}|玩家金钱数量|
 ---
-<!-- ## F
----
-## G
---- -->
-## **H**
-### **[HealthAPI](https://github.com/SmallasWater/HealthAPI)**
+## **[HealthAPI](https://github.com/SmallasWater/HealthAPI)**
 |变量名|变量介绍|
 |:-:|:-:|
 |{h}|玩家血量|
 |{mh}|玩家血量上限|
 |{hb}|玩家血量百分比|
 ---
-<!-- ## I
----
-## J
----
-## K
---- -->
-## **L**
-### **[LevelAwakenSystem](https://github.com/SmallasWater/LevelAwakenSystem)**
+## **[LevelAwakenSystem](https://github.com/SmallasWater/LevelAwakenSystem)**
 |变量名|变量介绍|
 |:-:|:-:|
 |{属性}|玩家的RPG属性|
@@ -65,13 +44,14 @@
 |{c}|玩家穿透|
 |{饰品}|玩家当前装备的饰品|
 |{pvp}|玩家PVP 状态 (暂时不可用)|
+## **[LuckPerms](https://luckperms.net/)**
+|变量名|变量介绍|
+|:-:|:-:|
+|{LuckPerms-prefix}|获取玩家的prefix(前缀)|
+|{LuckPerms-suffix}|获取玩家的suffix(后缀)|
+|{LuckPerms-group}|获取玩家所在的权限组|
 ---
-<!-- ## M
----
-## N
---- -->
-## **O**
-### **[OreArea](https://github.com/SmallasWater/OreArea)**
+## **[OreArea](https://github.com/SmallasWater/OreArea)**
 **注意: 变量`{orearea-time-use}`在有限时的矿区会有BUG(到秒就不动了)**
 |变量名|变量介绍|
 |:-:|:-:|
@@ -81,21 +61,18 @@
 |{orearea-time-reset}|获取玩家所在的刷新时间|
 |{orearea-name}|获取玩家所在的矿区等级|
 ---
-## **P**
-### **[playerPoints](https://github.com/SmallasWater/PlayerPoints)**
+## **[playerPoints](https://github.com/SmallasWater/PlayerPoints)**
 |变量名|变量介绍|
 |:-:|:-:|
 |{point}|获取玩家的点券数量|
 ---
-<!-- ## Q
---- -->
-## R
-### **[RsTask](https://github.com/MemoriesOfTime/RSTask)**
+## **[RsTask](https://github.com/MemoriesOfTime/RSTask)**
 |变量名|变量介绍|
 |:-:|:-:|
 |{task-name}|正在进行中的任务 (显示第一个)|
 |{task-count}|玩家任务积分|
-### **[RsWeapon](https://github.com/SmallasWater/RsWeapon)**
+---
+## **[RsWeapon](https://github.com/SmallasWater/RsWeapon)**
 |变量名|变量介绍|
 |:-:|:-:|
 |{武器名称}|玩家手持武器的名称|
@@ -114,20 +91,4 @@
 |{we-kick}|玩家武器击退值|
 |{we-dkick}|玩家盔甲抗击退值|
 |{we-todamage}|玩家盔甲反伤百分比|
----
-<!-- ## S
----
-## T
----
-## U
----
-## V
----
-## W
----
-## X
----
-## Y
----
-## Z
---- -->
+---

docs/config-info.md

@@ -1,29 +1,52 @@
-[![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.md) [![1](https://img.shields.io/badge/doc-%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E8%AF%B4%E6%98%8E-a?style=plastic)](./config-info.md) [![1](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E6%96%87%E5%AD%97%E7%9B%B8%E5%85%B3-a?style=plastic&color=blue)](./text-variables.md)
-[![2](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E7%8E%A9%E5%AE%B6%E7%9B%B8%E5%85%B3-a?style=plastic&color=blue)](./player-variables.md)
-[![3](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E6%9C%8D%E5%8A%A1%E5%99%A8%E7%9B%B8%E5%85%B3-a?style=plastic&color=blue)](./server-variables.md)
-[![4](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E6%94%AF%E6%8C%81%E7%9A%84%E6%8F%92%E4%BB%B6-a?style=plastic&color=blue)](./SupportPluginsVariables.md)
+[![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.md) [![1](https://img.shields.io/badge/doc-%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E8%AF%B4%E6%98%8E-a?style=plastic)](./config-info.md) [![2](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E6%96%87%E5%AD%97%E7%9B%B8%E5%85%B3-a?style=plastic&color=blue)](./text-variables.md)
+[![3](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E7%8E%A9%E5%AE%B6%E7%9B%B8%E5%85%B3-a?style=plastic&color=blue)](./player-variables.md)
+[![4](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E6%9C%8D%E5%8A%A1%E5%99%A8%E7%9B%B8%E5%85%B3-a?style=plastic&color=blue)](./server-variables.md)
+[![5](https://img.shields.io/badge/%E5%8F%98%E9%87%8F-%E6%94%AF%E6%8C%81%E7%9A%84%E6%8F%92%E4%BB%B6-a?style=plastic&color=blue)](./SupportPluginsVariables.md)
 
 ---
 # **配置文件使用说明**
-> **若未在此说明中写配置项出则代表该配置项还没有支持**
+- **若未在此说明中写配置项出则代表该配置项还没有支持,也有可能是忘记写出来了**
+- **给出的预览图片可能不是最新的，但也差不到哪去**
+---
 ## **[config.yml](../src/main/resources/config.yml)**
-> **主配置文件**
-### **是否释放新的变量说明文档**
+**主配置文件**
 ```yml
+#使用说明:
+#https://github.com/stevei5mc/NewTipsVariables/blob/main/README.md
+#https://gitee.com/stevei5mc/NewTipsVariables/blob/main/README.md
+#配置文件版本，勿动
+version: 1
+# 更新功能(这个功能展示没有用)
+updata:
+  in-plugin:
+    #检查更新(暂时没有用)
+    check: false
+    #自动更新(需开启检查更新但暂时没有用)
+    auto: false
+  in-config:
+    #检查更新
+    check: false
+    #自动更新(需开启检查更新)
+    auto: false
+# 是否释放新的变量说明文档
 save-variables-doc: true
-```
-1. 该配置项启用后，服务器每次启动后都会生成新的变量文档  
-2. 若关闭后，就算删除变量文档也不会生成新的变量文档
-3. 该配置项默认启用
-### **debug功能**
-```yml
 debug: false
 ```
-1. 这个功能默认关闭并不在配置文件中，需要手动填写  
-2. 把`debug: true`复制进`config.yml`即可启用
+1. `save-variables-doc` 该功能关闭后就算删除变量文档也不会生成新的变量文档
+2. `debug` 显示一些额外的信息  
+![6](./image/debug.PNG)  
+3. `updata -> in-config -> check` 配置文件版本检查
+4. `updata -> in-config -> auto` 配置文件自动更新(需开启检查更新)**注意： 开启后配置文件将强制更新不会保留原来的配置**  
+![7](./image/check_config.PNG)
+---
 ## **[server.yml](../src/main/resources/server.yml)**
-> **服务器相关变量配置文件**
+**服务器相关变量配置文件**
 ```yml
+#使用说明:
+#https://github.com/stevei5mc/NewTipsVariables/blob/main/README.md
+#https://gitee.com/stevei5mc/NewTipsVariables/blob/main/README.md
+#配置文件版本，勿动
+version: 1
 TPS:
   low_color: "§c"
   medium_value: 9
@@ -33,9 +56,15 @@ TPS:
 ```
 1. ```color```设置显示的颜色，```low```、```medium```、```high```为显示的范围 
 2. ```value```是一个范围值，```medium```、```high```为可设置的范围值，```low```值只能为```0```
+---
 ## **[player.yml](../src/main/resources/player.yml)**
-> **玩家相关变量配置文件**
+**玩家相关变量配置文件**
 ```yml
+#使用说明:
+#https://github.com/stevei5mc/NewTipsVariables/blob/main/README.md
+#https://gitee.com/stevei5mc/NewTipsVariables/blob/main/README.md
+#配置文件版本，勿动
+version: 1
 Device:
   OS:
     Android: "Android"
@@ -60,11 +89,6 @@ Device:
   UIProfile:
     classic: "classic ui"
     pocket: "pocket ui"
-```
-- **```OS```玩家的设备系统**  
-- **```Controls```获取玩家设备的操作方式**
-- **```UIProfile```玩家的设备UI**
-```yml
 ping:
   low_color: "§a"
   medium_value: 80
@@ -80,11 +104,17 @@ HP:
 Food:
   empty_color: "§7{0}/{1}"
   low_color: "§c{0}§7/§c{1}"
-  medium_value: 9 
+  medium_value: 9
   medium_color: "§e{0}§7/§e{1}"
   high_value: 15
   high_color: "§a{0}§7/§a{1}"
 ```
-1. ```color```设置显示的颜色，```low```、```medium```、```high```为显示的范围  
-1. ```value```是一个范围值，```medium```、```high```为可设置的范围值，```low```值只能为```0```
-1. ```symbols```是用来设置分割符号的，例如: ```HP: 20/20```
+1. `color`设置显示的颜色，`low`、`medium`、`high`为显示的范围  
+2. `value`是一个范围值，`medium`、`high` 为可设置的范围值，`empty`值只能为`0`，`low`值只能为`0`或`1`
+- **`Device -> OS`玩家的设备系统**  
+- **`Device -> Controls`获取玩家设备的操作方式**
+- **`Device -> UIProfile`玩家的设备UI**
+- **`ping` 玩家的延迟**
+- **`HP`  玩家的血量**
+- **`Food` 玩家的饥饿值**
+---

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>cn.stevei5mc</groupId>
     <artifactId>NewTipsVariables</artifactId>
-    <version>1.0.0-beta8</version>
+    <version>1.0.0-beta9</version>
 <repositories>
    <repository>
         <id>opencollab-repo-release</id>
@@ -89,6 +89,12 @@
         <scope>system</scope>
         <systemPath> ${project.basedir}/lib/RSWeapon.jar</systemPath>
     </dependency>
+    <dependency>
+        <groupId>net.luckperms</groupId>
+        <artifactId>api</artifactId>
+        <version>5.4</version>
+        <scope>provided</scope>
+    </dependency>
 </dependencies>
 <properties>
     <maven.compiler.source>8</maven.compiler.source>