1
mirror of https://github.com/CarmJos/UserPrefix.git synced 2024-09-19 12:05:47 +00:00

docs(README): 修改部分配置文件介绍

This commit is contained in:
Carm Jos 2022-07-01 15:45:13 +08:00
parent 899acbe2cc
commit 23db43604c
2 changed files with 10 additions and 24 deletions

View File

@ -42,7 +42,6 @@ For development dependencies, please see [Dependencies](https://github.com/Carm
- Real-time judgment and feedback to the player when permissions are changed. - Real-time judgment and feedback to the player when permissions are changed.
- Configurable sounds and messages. - Configurable sounds and messages.
- The prefix icon can be configured as "Selected", "Has Permission" and “No Permission”. - The prefix icon can be configured as "Selected", "Has Permission" and “No Permission”.
- Item configuration is natively configured through ItemStack, which supports all MC settings!
- TabList is automatically sorted according to the weight of the prefix (if there is a conflict, it can be turned off) - TabList is automatically sorted according to the weight of the prefix (if there is a conflict, it can be turned off)
- The prefix display on the player name (can be turned off if there has any conflict) - The prefix display on the player name (can be turned off if there has any conflict)
- Simple Chat Format Placeholder support. (Not Recommended) - Simple Chat Format Placeholder support. (Not Recommended)
@ -67,12 +66,7 @@ becomes "`ENTITY_VILLAGER_YES`" in the higher version.
The display of the prefix on the head and the sorting of the TabList both use the scoreboard API. The display of the prefix on the head and the sorting of the TabList both use the scoreboard API.
Please turn of the `functions.OnNamePrefix` in the configuration if there is a conflict. Please turn of the `functions.on-name-prefix` in the configuration if there is a conflict.
### 3. Item icon configuration problem
Items are read through the ItemStack serialization method provided by Bukkit. For related configuration methods, please
refer to [ItemStack Serialization](https://www.spigotmc.org/wiki/itemstack-serialization/).
## Commands ## Commands
@ -106,14 +100,13 @@ type `/papi info UserPrefix` to see all the placeholders.
## Configuration files ## Configuration files
### Plugin Configuration ([`config.yml`](src/main/resources/en_US/config.yml) . ### Plugin Configuration ([`config.yml`]() .
Notice: The default configuration is based on Chinese. You can find Will be generated on the first boot up.
the [English Version here](src/main/resources/en_US/config.yml).
### Messages Configuration ([`messages.yml`](src/main/resources/en_US/messages.yml)) ### Messages Configuration ([`messages.yml`]())
Please see the [Source File](src/main/resources/en_US/messages.yml) . Will be generated on the first boot up.
### Prefixes Configuration ([`prefixes/*.yml`](src/main/resources/en_US/example-prefix.yml)) ### Prefixes Configuration ([`prefixes/*.yml`](src/main/resources/en_US/example-prefix.yml))

View File

@ -37,8 +37,6 @@ README LANGUAGES [ [**中文**](README.md) | [English](README-en.md) ]
- 当玩家权限变更时会实时监测前缀,若权限不足则自动更换前缀并提示 - 当玩家权限变更时会实时监测前缀,若权限不足则自动更换前缀并提示
- 可配置的声音、消息! - 可配置的声音、消息!
- 前缀图标可配置“选中”、“有权限”与“无权限”三种状态的物品 - 前缀图标可配置“选中”、“有权限”与“无权限”三种状态的物品
- 物品的配置通过ItemStack原生配置支持MC所有的设定
- 具体的设定请参考其他文档哦~
- TabList自动按照前缀的权重排序 (如有冲突可关掉) - TabList自动按照前缀的权重排序 (如有冲突可关掉)
- 玩家头顶前缀显示 (如有冲突可关掉) - 玩家头顶前缀显示 (如有冲突可关掉)
- 简单的聊天变量修改功能!(不推荐使用) `[自 v2.1.0 版本起]` - 简单的聊天变量修改功能!(不推荐使用) `[自 v2.1.0 版本起]`
@ -60,12 +58,7 @@ README LANGUAGES [ [**中文**](README.md) | [English](README-en.md) ]
头顶上前缀的显示与TabList的排序均使用到了计分板API。 头顶上前缀的显示与TabList的排序均使用到了计分板API。
如有冲突导致其他插件的计分板无法显示,请关掉配置文件中`functions.OnNamePrefix`。 如有冲突导致其他插件的计分板无法显示,请关掉配置文件中`functions.on-name-prefix`。
### 3. 物品图标配置问题
物品相关均通过Bukkit提供的ItemStack序列化方法读取相关配置方式请参考[ItemStack Serialization(物品序列化)](https://www.spigotmc.org/wiki/itemstack-serialization/)
## 指令 ## 指令
@ -99,13 +92,13 @@ README LANGUAGES [ [**中文**](README.md) | [English](README-en.md) ]
## 配置文件示例 ## 配置文件示例
### 基础配置文件 ([`config.yml`](src/main/resources/config.yml)) ### 基础配置文件 ([`config.yml`](src/main/java/cc/carm/plugin/userprefix/configuration/PluginConfig.java))
将会在服务器首次启动时生成,如果您想要修改配置,请在服务器启动后打开配置文件,详见 [示例文件](src/main/resources/config.yml) 将会在服务器首次启动时生成,如果您想要修改配置,请在服务器启动后打开配置文件。
### 消息配置文件 ([`messages.yml`](src/main/resources/messages.yml)) ### 消息配置文件 ([`messages.yml`](src/main/java/cc/carm/plugin/userprefix/configuration/PluginMessages.java))
将会在服务器首次启动时生成,如果您想要修改配置,请在服务器启动后打开配置文件, 详见 [示例文件](src/main/resources/messages.yml) 将会在服务器首次启动时生成,如果您想要修改配置,请在服务器启动后打开配置文件 。
### 前缀配置文件 ([`prefixes/*.yml`](src/main/resources/prefixes/example-prefix.yml)) ### 前缀配置文件 ([`prefixes/*.yml`](src/main/resources/prefixes/example-prefix.yml))