1.0.0-beta8

.github/workflows/pr-check.yml

@@ -1,27 +1,27 @@
-name: pr-check
-on:
-  pull_request:
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - name: 获取信息
-      id: get_info
-      run: echo "repository_name=${GITHUB_REPOSITORY/${{ github.repository_owner }}\//}" >> $GITHUB_OUTPUT
-    - name: 拉取代码
-      uses: actions/checkout@v3
-    - name: 安装java8
-      uses: actions/setup-java@v3
-      with:
-        java-version: '8'
-        distribution: 'temurin'
-        cache: maven
-    - name: 构建
-      run: |
-        mvn -B package --file pom.xml
-        mkdir staging && cp target/*.jar staging
-    - name: 收集构建文件
-      uses: actions/upload-artifact@v1
-      with:
-        name: ${{ steps.get_info.outputs.repository_name }}-Pr_check-Build-${{ github.run_number}}
+name: pr-check
+on:
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: 获取信息
+      id: get_info
+      run: echo "repository_name=${GITHUB_REPOSITORY/${{ github.repository_owner }}\//}" >> $GITHUB_OUTPUT
+    - name: 拉取代码
+      uses: actions/checkout@v3
+    - name: 安装java8
+      uses: actions/setup-java@v3
+      with:
+        java-version: '8'
+        distribution: 'temurin'
+        cache: maven
+    - name: 构建
+      run: |
+        mvn -B package --file pom.xml
+        mkdir staging && cp target/*.jar staging
+    - name: 收集构建文件
+      uses: actions/upload-artifact@v1
+      with:
+        name: ${{ steps.get_info.outputs.repository_name }}-PR_${{ github.event.pull_request.number }}-Build_${{ github.run_number}}
         path: staging

.github/workflows/tagpush.yml

@@ -35,7 +35,7 @@ jobs:
         tag: ${{ steps.get_info.outputs.VERSION }}
         name: ${{ steps.get_info.outputs.VERSION }}
         token: ${{ secrets.GITHUB_TOKEN }}
-        bodyFile: ./changelogs/${{ steps.get_info.outputs.VERSION }}.md
+        bodyFile: ./docs/changelogs/${{ steps.get_info.outputs.VERSION }}.md
         artifacts: ./target/${{ steps.get_info.outputs.repository_name }}-${{ steps.get_info.outputs.VERSION }}.jar
     # 这个暂时没有用
     # - name: 发布至minebbs
@@ -45,5 +45,5 @@ jobs:
     #     token: ${{ secrets.MINEBBSKEY }}
     #     title: ${{ steps.get_info.outputs.VERSION }}
     #     new_version: ${{ steps.get_info.outputs.VERSION }}
-    #     description_file: ./changelogs/${{ steps.get_info.outputs.VERSION }}.md
+    #     description_file: ./docs/changelogs/${{ steps.get_info.outputs.VERSION }}.md
     #     file_url: 'https://github.com/${{ github.repository }}/releases/latest'

README.md

@@ -1,17 +1,33 @@
 # NewTipsVariables
-## 插件介绍
 [![GitHub License](https://img.shields.io/github/license/stevei5mc/NewTipsVariables?style=plastic)](LICENSE)
 ![GitHub top language](https://img.shields.io/github/languages/top/stevei5mc/NewTipsVariables?style=plastic)
 [![GitHub Release](https://img.shields.io/github/v/release/stevei5mc/NewTipsVariables?style=plastic&color=drak%20green)](https://github.com/stevei5mc/NewTipsVariables/releases)  
 ![GitHub Repo stars](https://img.shields.io/github/stars/stevei5mc/NewTipsVariables?style=plastic)
 ![GitHub forks](https://img.shields.io/github/forks/stevei5mc/NewTipsVariables?style=plastic)
 ![GitHub issues](https://img.shields.io/github/issues/stevei5mc/NewTipsVariables?style=plastic&color=linkGreen)
 ![GitHub pull requests](https://img.shields.io/github/issues-pr/stevei5mc/NewTipsVariables?style=plastic)  
-> **该插件可以为Tips添加更多的变量内容，更多变量敬请期待**
-## 使用方法
-> **1、将插件放进`plugins`文件夹**  
-> **2、需确保安装`Tips`插件后重启服务器**  
-> **3、在`/plugins/NewTipsVariables`文件夹中的`.txt`文件获取相关变量介绍，也可在本页面获取相关的变量介绍**  
-### **[配置文件使用说明](./docs/config-info.md)**
+## **插件介绍**
+### **前言**
+- **该插件可以为Tips提供更多的变量内容**  
+- **目前该插件正处于`beta`测试阶段如果有问题请及时提交[issues](https://github.com/stevei5mc/NewTipsVariables/issues)**  
+- **如果你有开发能力可以为其提供[PR](https://github.com/stevei5mc/NewTipsVariables/pulls)来增加更多变量或修复问题**
+### **支持下列插件的**
+**[EconomyAPI][i1] [HealthAPI][i1] [LevelAwakenSystem][i1] [OreArea][i1] [playerPoints][i1] [RsTask][i1] [RsWeapon][i1]** 
+### **命令与权限节点**
+|命令|权限节点|权限介绍|默认权限|
+|:-:|:-:|:-:|:-:|
+|/newtipsariables|newtipsariables.admin|主命令|OP|
+|/newtipsariables reload|newtipsariables.admin.reload|重载配置文件|OP|
 ### **变量介绍**
-**[文字相关变量](./docs/text-variables.md) [玩家相关变量](./docs/player-variables.md) [服务器相关变量](./docs/server-variables.md) [支持的插件](./docs/SupportPluginsVariables.md)**
+**[文字相关变量][i2] [玩家相关变量][i3] [服务器相关变量][i4] [支持的插件][i1]**
+### **[配置文件使用说明][i5]**
+## **使用方法**
+1. **将插件放进`plugins`文件夹**  
+2. **需确保安装[Tips](https://motci.cn/job/Tips/)插件后重启服务器**  
+3. **在`./plugins/NewTipsVariables`文件夹中的`.txt`文件获取相关变量介绍，也可在本页面获取相关的变量介绍**  
+
+[i1]: ./docs/SupportPluginsVariables.md "点击查看变量文档"
+[i2]: ./docs/text-variables.md "点击查看变量文档"
+[i3]: ./docs/player-variables.md "点击查看变量文档"
+[i4]: ./docs/server-variables.md "点击查看变量文档"
+[i5]: ./docs/config-info.md "点击查看配置文件相关介绍"

docs/SupportPluginsVariables.md

@@ -1,56 +1,80 @@
-[![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&color=blue)
+[![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&color=blue)
 ](./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)
+[![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)
-[![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)
+[![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)
-[![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)
+[![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)
-[![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)
+[![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)
 ](./SupportPluginsVariables.md)
-
+# **变量文档(支持的插件)**
 ---
 > **按插件的英文字母排序**  
 > **TipsVeriable 相关变量移值中,部分变量名有改动**
 
-## A
+<!-- ## A
 ---
 ## B
 ---
 ## C
 ---
 ## D
----
+--- -->
 ## **E**
 ### **[EconomyAPI](https://github.com/Nukkit-coders/EconomyAPI)**
 |变量名|变量介绍|
-|-|-|
+|:-:|:-:|
 |{economyApi-money}|玩家金钱数量|
 ---
-## F
+<!-- ## F
 ---
 ## G
+--- -->
+## **H**
+### **[HealthAPI](https://github.com/SmallasWater/HealthAPI)**
+|变量名|变量介绍|
+|:-:|:-:|
+|{h}|玩家血量|
+|{mh}|玩家血量上限|
+|{hb}|玩家血量百分比|
 ---
-## H
----
-## I
+<!-- ## I
 ---
 ## J
 ---
 ## K
----
-## L
----
-## M
+--- -->
+## **L**
+### **[LevelAwakenSystem](https://github.com/SmallasWater/LevelAwakenSystem)**
+|变量名|变量介绍|
+|:-:|:-:|
+|{属性}|玩家的RPG属性|
+|{天赋}|玩家评分|
+|{level}|玩家等级|
+|{exp}|玩家当前经验|
+|{mexp}|玩家当前经验最大值|
+|{dw}|玩家物理攻击|
+|{df}|玩家法术攻击|
+|{dlw}|玩家物理防御|
+|{dlf}|玩家法术防御|
+|{b}|玩家暴击|
+|{kb}|玩家抗暴|
+|{kx}|玩家抗性|
+|{c}|玩家穿透|
+|{饰品}|玩家当前装备的饰品|
+|{pvp}|玩家PVP 状态 (暂时不可用)|
+---
+<!-- ## M
 ---
 ## N
----
+--- -->
 ## **O**
 ### **[OreArea](https://github.com/SmallasWater/OreArea)**
 **注意: 变量`{orearea-time-use}`在有限时的矿区会有BUG(到秒就不动了)**
 |变量名|变量介绍|
-|-|-|
+|:-:|:-:|
 |{orearea-level-this}|获取玩家的矿区等级|
 |{orearea-level-next}|获取玩家的矿区下一等级|
 |{orearea-time-use}|获取玩家所在的矿区可以使用的时间|
@@ -60,19 +84,38 @@
 ## **P**
 ### **[playerPoints](https://github.com/SmallasWater/PlayerPoints)**
 |变量名|变量介绍|
-|-|-|
+|:-:|:-:|
 |{point}|获取玩家的点券数量|
 ---
-## Q
----
+<!-- ## Q
+--- -->
 ## R
 ### **[RsTask](https://github.com/MemoriesOfTime/RSTask)**
 |变量名|变量介绍|
-|-|-|
+|:-:|:-:|
 |{task-name}|正在进行中的任务 (显示第一个)|
 |{task-count}|玩家任务积分|
----
-## S
+### **[RsWeapon](https://github.com/SmallasWater/RsWeapon)**
+|变量名|变量介绍|
+|:-:|:-:|
+|{武器名称}|玩家手持武器的名称|
+|{宝石个数}|玩家手持武器的宝石个数|
+|{头盔}|玩家装备的头盔|
+|{胸甲}|玩家装备的胸甲|
+|{护腿}|玩家装备的护腿|
+|{靴子}|玩家装备的靴子|
+|{头盔宝石}|玩家装备的头盔宝石个数|
+|{胸甲宝石}|玩家装备的胸甲宝石个数|
+|{护腿宝石}|玩家装备的护腿宝石个数|
+|{靴子宝石}|玩家装备的靴子宝石个数|
+|{we-damage}|玩家武器攻击力|
+|{we-armor}|玩家盔甲护甲值|
+|{we-health}|玩家盔甲生命值|
+|{we-kick}|玩家武器击退值|
+|{we-dkick}|玩家盔甲抗击退值|
+|{we-todamage}|玩家盔甲反伤百分比|
+---
+<!-- ## S
 ---
 ## T
 ---
@@ -87,4 +130,4 @@
 ## Y
 ---
 ## Z
----
+--- -->

docs/config-info.md

@@ -12,15 +12,15 @@
 ```yml
 save-variables-doc: true
 ```
-> **1、该配置项启用后，服务器每次启动后都会生成新的变量文档**  
-> **2、若关闭后，就算删除变量文档也不会生成新的变量文档**  
-> **3、该配置项默认启用**
+1. 该配置项启用后，服务器每次启动后都会生成新的变量文档  
+2. 若关闭后，就算删除变量文档也不会生成新的变量文档
+3. 该配置项默认启用
 ### **debug功能**
 ```yml
 debug: false
 ```
-> 1、这个功能默认关闭并不在配置文件中，需要手动填写  
-> 2、把`debug: true`复制进`config.yml`即可启用
+1. 这个功能默认关闭并不在配置文件中，需要手动填写  
+2. 把`debug: true`复制进`config.yml`即可启用
 ## **[server.yml](../src/main/resources/server.yml)**
 > **服务器相关变量配置文件**
 ```yml
@@ -31,18 +31,18 @@ TPS:
   high_value: 15
   high_color: "§a"
 ```
-> **1、```color```设置显示的颜色，```low```、```medium```、```high```为显示的范围**  
-> **2、```value```是一个范围值，```medium```、```high```为可设置的范围值，```low```值只能为```0```**
+1. ```color```设置显示的颜色，```low```、```medium```、```high```为显示的范围 
+2. ```value```是一个范围值，```medium```、```high```为可设置的范围值，```low```值只能为```0```
 ## **[player.yml](../src/main/resources/player.yml)**
 > **玩家相关变量配置文件**
 ```yml
 Device:
   OS:
-    Android: "安卓"
-    iOS: "苹果"
-    macOS: "苹果但是电脑"
-    Fire_OS: "Fire_OS"
-    Gear_VR: "Gear_VR"
+    Android: "Android"
+    iOS: "iOS"
+    macOS: "macOS"
+    Fire_OS: "Fire OS"
+    Gear_VR: "Gear VR"
     HoloLens: "HoloLens"
     Windows_10: "Windows 10"
     Windows: "Windows"
@@ -51,13 +51,19 @@ Device:
     PlayStation: "PlayStation"
     Switch: "Switch"
     Xbox: "Xbox"
-    Windows_Phone: "windows但是手机"
+    Windows_Phone: "Windows Phone"
+  Controls:
+    Keyboard: Keyboard
+    Touch: Touch
+    pad: pad
+    motion_controller: motion_controller
   UIProfile:
     classic: "classic ui"
     pocket: "pocket ui"
 ```
-> 1、**```OS```玩家的设备系统**  
-> 2、**```UIProfile```玩家的设备UI**
+- **```OS```玩家的设备系统**  
+- **```Controls```获取玩家设备的操作方式**
+- **```UIProfile```玩家的设备UI**
 ```yml
 ping:
   low_color: "§a"
@@ -79,6 +85,6 @@ Food:
   high_value: 15
   high_color: "§a{0}§7/§a{1}"
 ```
-> **1、```color```设置显示的颜色，```low```、```medium```、```high```为显示的范围**  
-> **2、```value```是一个范围值，```medium```、```high```为可设置的范围值，```low```值只能为```0```**  
-> **3、```symbols```是用来设置分割符号的，例如: ```HP: 20/20```**
+1. ```color```设置显示的颜色，```low```、```medium```、```high```为显示的范围  
+1. ```value```是一个范围值，```medium```、```high```为可设置的范围值，```low```值只能为```0```
+1. ```symbols```是用来设置分割符号的，例如: ```HP: 20/20```

docs/player-variables.md

@@ -1,13 +1,14 @@
-[![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&color=blue)](./config-info.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&color=blue)](./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)](./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)
 # **变量文档(玩家相关)**
-[![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)](./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)
 
 ---
 |变量|介绍|备注|
-|-|-|-|
+|:-:|:-:|:-:|
 |{Player-Xp}|获取玩家在游戏中的经验等级||
 |{Device-Model}|获取玩家使用的设备型号||
 |{XUID}|获取玩家的xuid||
@@ -19,4 +20,7 @@
 |{Player-Food}|获取玩家当前的饥饿度||
 |{Player-Health}|获取玩家当前的血量||
 |{Player-World}|获取玩家所在的世界|**需在world_name.yml配置**|
-|{Player-Controls}|获取玩家设备的操作方式||
+|{Player-Controls}|获取玩家设备的操作方式||
+|{Player-Yaw}|获取玩家的Yaw值||
+|{Player-Pitch}|获取玩家的Pitch值||
+|{Player-HeadYaw}|获取玩家的HeadYaw值||