diff --git a/README.md b/README.md index e3cb067..826c15f 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,6 @@ - **该插件可以为Tips提供更多的变量内容** - **目前该插件正处于`beta`测试阶段如果有问题请及时提交[issues](https://github.com/stevei5mc/NewTipsVariables/issues)** - **如果你有开发能力可以为其提供[PR](https://github.com/stevei5mc/NewTipsVariables/pulls)来增加更多变量或修复问题** -### **[支持下列插件](./docs/SupportPluginsVariables.md "点击查看变量文档")** -**EconomyAPI HealthAPI LevelAwakenSystem OreArea playerPoints RsTask RsWeapon LuckPerms** ### **命令与权限节点** |命令|权限节点|权限介绍|默认权限| |:-:|:-:|:-:|:-:| @@ -20,9 +18,7 @@ |/newtipsariables reload|newtipsariables.admin.reload|重载配置文件|OP| |/newtipsariables checkstatus|newtipsariables.admin.checkstate|检查插件状态|OP| ### **变量介绍文档** -- **[文字相关变量][i2]** -- **[玩家相关变量][i3]** -- **[服务器相关变量][i4]** +- **[基础变量](./docs/base-variables.md)** - **[支持下列插件](./docs/SupportPluginsVariables.md "点击查看变量文档")** ### **配置文件使用说明** - **若未在此说明中写配置项出则代表该配置项还没有支持,也有可能是忘记写出来了** @@ -155,9 +151,6 @@ Food: |3|在`./plugins/NewTipsVariables`文件夹中的`.txt`文件获取相关变量介绍,也可在本页面获取相关的变量介绍就可以在Tips中使用同时也可以在支持Tips变量的插件中使用| ## **注意事项及建议** 1. **不建议开启配置文件的自动更新,如果开启后配置文件有更新会覆盖式更新就会导致原有的配置丢失** -2. **预计发布beta10之后如果没有问题发布正式版该版本,有问题或者需求请及时提出[issue](https://github.com/stevei5mc/NewTipsVariables/issues)** +2. **预计1.0.0-beta10之后如果没有问题发布正式版该版本,有问题或者需求请及时提出[issue](https://github.com/stevei5mc/NewTipsVariables/issues)** 3. **建议备份好已经配置好的配置文件以备不时之需** - -[i2]: ./docs/text-variables.md "点击查看变量文档" -[i3]: ./docs/player-variables.md "点击查看变量文档" -[i4]: ./docs/server-variables.md "点击查看变量文档" \ No newline at end of file +4. **1.0.0-beta10之后合并了[UnicodeVariables](https://github.com/stevei5mc/UnicodeVariables)插件的相关功能,更新至1.0.0-beta10就可以删除[UnicodeVariables](https://github.com/stevei5mc/UnicodeVariables)了** \ No newline at end of file diff --git a/docs/SupportPluginsVariables.md b/docs/SupportPluginsVariables.md index a80f72a..b6f2e86 100644 --- a/docs/SupportPluginsVariables.md +++ b/docs/SupportPluginsVariables.md @@ -1,10 +1,4 @@ [![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.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) ](./SupportPluginsVariables.md) # **变量文档(支持的插件)** diff --git a/docs/base-variables.md b/docs/base-variables.md new file mode 100644 index 0000000..ce7681e --- /dev/null +++ b/docs/base-variables.md @@ -0,0 +1,50 @@ +[![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.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) +# **变量文档 (基础变量)** + +## **文字相关** +|变量名|对应内容|变量名|对应内容|变量名|对应内容|变量名|对应内容| +|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|{text-s0}|§0|{text-s1}|§1|{text-s2}|§2|{text-s3}|§3| +|{text-s4}|§4|{text-s5}|§5|{text-s6}|§6|{text-s7}|§7| +|{text-s8}|§8|{text-s9}|§9|{text-sa}|§a|{text-sb}|§b| +|{text-sc}|§c|{text-sd}|§d|{text-se}|§e|{text-sf}|§f| +|{text-bold}|§l|{text-italic}|§o|{text-reset}|§r|{text-mess}|§k| +|{text-next}|\n||||||| +## **玩家相关** +|变量|介绍|备注| +|:-:|:-:|:-:| +|{Player-Xp}|获取玩家在游戏中的经验等级|| +|{Device-Model}|获取玩家使用的设备型号|| +|{XUID}|获取玩家的xuid|| +|{Player-Lang}|获取玩家客户端使用的语言|| +|{Player-Ui}|获取玩家客户端使用的UI|| +|{Device-Os}|获取玩家设备的系统|| +|{{Player-Uuid}|获取玩家的uuid|| +|{Player-Ping}|获取玩家当前的延迟|| +|{Player-Food}|获取玩家当前的饥饿度|| +|{Player-Health}|获取玩家当前的血量|| +|{Player-World}|获取玩家所在的世界|**需在world_name.yml配置相关内容方可生效**| +|{Player-Controls}|获取玩家设备的操作方式|| +|{Player-Yaw}|获取玩家的Yaw值|| +|{Player-Pitch}|获取玩家的Pitch值|| +|{Player-HeadYaw}|获取玩家的HeadYaw值|| +## **服务器相关** +|变量|介绍|备注| +|:-:|:-:|:-:| +|{Server-Motd}|获取服务器主motd|| +|{Server-SubMotd}|获取服务器副motd|| +|{Server-Ip}|获取服务器IP|| +|{Server-Port}|获取服务器端口|| +|{Server-Tps}|获取服务器当前TPS|| +|{WorldOnline@世界名}|获取指定世界的人数|| +## **unicode相关变量** +- **例如你想要显示金币的图标那么就要确定金币图标所在的位置** + ![e1](image/glyph_E1.png) +- **glyph_E1.png** +--- +- **如上图所示金币的图标在glyph_E1的第0行第2列(16进制表示)** +- **那么金币图标的变量就为`{E102}`** +- **其他的图标变量值也是这么确定的** +- **注意变量必须要以 `{`开头 `}`结尾 中间是图标所在位置 例`E102`** \ No newline at end of file diff --git a/docs/changelogs/1.0.0-beta10.md b/docs/changelogs/1.0.0-beta10.md new file mode 100644 index 0000000..55d3620 --- /dev/null +++ b/docs/changelogs/1.0.0-beta10.md @@ -0,0 +1,28 @@ +# **1.0.0-beta10** +--- +## **注意事项** +1. **不建议开启配置文件的自动更新,如果开启后配置文件有更新会覆盖式更新就会导致原有的配置丢失** +2. **预计beta10之后如果没有问题发布正式版该版本,有问题或者需求请及时提出[issue](https://github.com/stevei5mc/NewTipsVariables/issues)** +3. **建议备份好已经配置好的配置文件以备不时之需** +4. **1.0.0-beta10之后合并了[UnicodeVariables](https://github.com/stevei5mc/UnicodeVariables)插件的相关功能,更新至1.0.0-beta10就可以删除[UnicodeVariables](https://github.com/stevei5mc/UnicodeVariables)了** +--- +## **更新内容** +1. 调整代码 <[4322c34](https://github.com/stevei5mc/NewTipsVariables/commit/4322c34c45ec680323f41d57710de751d568c400)> +2. 添加注释 +3. 将部分提示信息改到服务器启动完成后发出 <[1b55d24](https://github.com/stevei5mc/NewTipsVariables/commit/1b55d2496a79ef8fb232f0a28841e3924849d559)> +4. 修复配置文件自动更新后不能获取最新的配置内容的问题 <[6e20179](https://github.com/stevei5mc/NewTipsVariables/commit/6e20179c8975425787c61c2b4b905078629091cf)> +5. 调整部分代码 <[715a69b](https://github.com/stevei5mc/NewTipsVariables/commit/715a69bcdafd5f296781cf9c842c140db6b7dd58)> +6. 调整代码中的注释 <[4ece6ef](https://github.com/stevei5mc/NewTipsVariables/commit/4ece6ef8cb267bb369be18a01d71637d57f1c3f9)> +7. 调整和优化代码 +8. 支持世界名的通配符 <[63b95e1](https://github.com/stevei5mc/NewTipsVariables/commit/63b95e1dd52b16f33af81b0bd3c3741eea2582be)> +9. 添加变量 {LuckPerms-group-weight} <[de42f62](https://github.com/stevei5mc/NewTipsVariables/commit/de42f62c45070a2bab1d5820249e2f6b11374dcc)> +10. 修整文档 <[1a150b9](https://github.com/stevei5mc/NewTipsVariables/commit/1a150b9d561114f676b6b897b9ee25d22bd5f2a3)> +11. 将配置文件的自动更新功能和重置功能区分开 <[a24e64b](https://github.com/stevei5mc/NewTipsVariables/commit/a24e64bc27fed762b2d7b5a236ba9708a11f7d5c)> +12. 调整注释 +13. 调整代码 +14. 重写插件是否存在的判断 <[43c84c7](https://github.com/stevei5mc/NewTipsVariables/commit/43c84c78161d323e9e7c3c32170f4e05f8fac20c)> <[2d77c2f](https://github.com/stevei5mc/NewTipsVariables/commit/2d77c2fecb2245281ad22ffb69315077abf4586b)> +15. 增加受支持插件的状态检查的功能 <[3312eab](https://github.com/stevei5mc/NewTipsVariables/commit/3312eab9384d3a3e766378aefb54e22685a5df87)> +16. 对部分文案进行调整 <[4861f2c](https://github.com/stevei5mc/NewTipsVariables/commit/4861f2c131c72b5c3017a3d3b02ca4e9d00a64df)> +17. 调整代码 <[5e53ce2](https://github.com/stevei5mc/NewTipsVariables/commit/5e53ce26897748f969802ff5c929390e3ae9ed3a)> +18. 合并插件[UnicodeVariables](https://github.com/stevei5mc/UnicodeVariables)的功能 <[61ae8bd](https://github.com/stevei5mc/NewTipsVariables/commit/61ae8bde63e75742f72b65e4524d2dd3c7a54188)> +19. 玩家不在线时不调用变量 <[724593b](https://github.com/stevei5mc/NewTipsVariables/commit/724593bb55f3e8267a07a580c5aaa96dbda6ed5c)> \ No newline at end of file diff --git a/docs/image/1.PNG b/docs/image/1.PNG new file mode 100644 index 0000000..7b411cb Binary files /dev/null and b/docs/image/1.PNG differ diff --git a/docs/image/2.JPG b/docs/image/2.JPG new file mode 100644 index 0000000..62d9dfa Binary files /dev/null and b/docs/image/2.JPG differ diff --git a/docs/image/3.PNG b/docs/image/3.PNG new file mode 100644 index 0000000..add966f Binary files /dev/null and b/docs/image/3.PNG differ diff --git a/docs/image/4.JPG b/docs/image/4.JPG new file mode 100644 index 0000000..f4d6294 Binary files /dev/null and b/docs/image/4.JPG differ diff --git a/docs/image/glyph_E1.png b/docs/image/glyph_E1.png new file mode 100644 index 0000000..0858afd Binary files /dev/null and b/docs/image/glyph_E1.png differ diff --git a/docs/player-variables.md b/docs/player-variables.md deleted file mode 100644 index 86bf249..0000000 --- a/docs/player-variables.md +++ /dev/null @@ -1,25 +0,0 @@ -[![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.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) -# **变量文档(玩家相关)** - ---- -|变量|介绍|备注| -|:-:|:-:|:-:| -|{Player-Xp}|获取玩家在游戏中的经验等级|| -|{Device-Model}|获取玩家使用的设备型号|| -|{XUID}|获取玩家的xuid|| -|{Player-Lang}|获取玩家客户端使用的语言|| -|{Player-Ui}|获取玩家客户端使用的UI|| -|{Device-Os}|获取玩家设备的系统|| -|{{Player-Uuid}|获取玩家的uuid|| -|{Player-Ping}|获取玩家当前的延迟|| -|{Player-Food}|获取玩家当前的饥饿度|| -|{Player-Health}|获取玩家当前的血量|| -|{Player-World}|获取玩家所在的世界|**需在world_name.yml配置**| -|{Player-Controls}|获取玩家设备的操作方式|| -|{Player-Yaw}|获取玩家的Yaw值|| -|{Player-Pitch}|获取玩家的Pitch值|| -|{Player-HeadYaw}|获取玩家的HeadYaw值|| \ No newline at end of file diff --git a/docs/server-variables.md b/docs/server-variables.md deleted file mode 100644 index d534539..0000000 --- a/docs/server-variables.md +++ /dev/null @@ -1,16 +0,0 @@ -[![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.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)](./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) -# **变量文档(服务器相关)** - ---- -|变量|介绍|备注| -|:-:|:-:|:-:| -|{Server-Motd}|获取服务器主motd|| -|{Server-SubMotd}|获取服务器副motd|| -|{Server-Ip}|获取服务器IP|| -|{Server-Port}|获取服务器端口|| -|{Server-Tps}|获取服务器当前TPS|| -|{WorldOnline@世界名}|获取指定世界的人数|| \ No newline at end of file diff --git a/docs/text-variables.md b/docs/text-variables.md deleted file mode 100644 index 59ac2ec..0000000 --- a/docs/text-variables.md +++ /dev/null @@ -1,16 +0,0 @@ -[![0](https://img.shields.io/badge/%3C%3D-%E8%BF%94%E5%9B%9E-a?style=plastic&color=yellow)](.././README.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)](./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) -# **变量文档(文字相关)** - ---- -|变量名|对应内容|变量名|对应内容|变量名|对应内容|变量名|对应内容| -|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|{text-s0}|§0|{text-s1}|§1|{text-s2}|§2|{text-s3}|§3| -|{text-s4}|§4|{text-s5}|§5|{text-s6}|§6|{text-s7}|§7| -|{text-s8}|§8|{text-s9}|§9|{text-sa}|§a|{text-sb}|§b| -|{text-sc}|§c|{text-sd}|§d|{text-se}|§e|{text-sf}|§f| -|{text-bold}|§l|{text-italic}|§o|{text-reset}|§r|{text-mess}|§k| -|{text-next}|\n||||||| \ No newline at end of file