@@ -19,11 +19,14 @@ A plugin aiming to allow for simple player-selected prefixes that can be used in
1919
2020# Features
2121
22+ <img src =' https://user-images.githubusercontent.com/20095065/215312375-0cb1f307-2eae-43c4-bbf9-2b306bad5952.png ' width =40% > <img src =' https://user-images.githubusercontent.com/20095065/215312448-666f183a-d6a8-4aa0-a643-6694ff52b670.png ' width =40% >
23+
24+ - Player friendly GUI for selecting nicknames.
2225- Does not interact with any other plugins directly.
23- - The plugin uses and hold prefixes in a placeholder, it will not affect permission groups.
26+ - The plugin uses and hold prefixes in a placeholder, it will not affect permission groups / meta .
2427- Supports PlaceholderAPI Placeholders.
2528- Supports Mini-Message formatting.
26- - Supports multiple types of requirements: PERMISSION, STATISTIC, ADVANCEMENT, COMPARE_INT
29+ - Supports multiple types of requirements: ` PERMISSION ` , ` STATISTIC ` , ` ADVANCEMENT ` , ` COMPARE_INT `
2730
2831# Placeholders, Commands, and Permissions
2932
@@ -49,21 +52,6 @@ A plugin aiming to allow for simple player-selected prefixes that can be used in
4952``` yml
5053saving-type : " file"
5154default-prefix : " <white>[<gray>Player</gray>]</white> "
52-
53- prefix-id :
54- display-name : " Prefix ID"
55- description :
56- - " This is to show an example Prefix!"
57- - " This is a second line of description!"
58- prefix : " <white>[<rainbow>Something</rainbow>]</white> "
59- verify-always : false
60- show-when-locked : true
61- requirements :
62- - " permission simpleprefix.example true"
63- - " statistic PLAYER_KILLS >= 10"
64- - " advancement nether/summon_wither true"
65- - " compare_str %placeholder% == string"
66- - " compare_int %placeholder% < 1"
6755` ` `
6856
6957## Configuration Settings
@@ -90,7 +78,23 @@ __YML File (FILE)__
9078>
9179> This is default.
9280
93- # ## Creating Prefixes
81+ # # Creating Prefixes
82+
83+ ` ` ` yml
84+ prefix-id:
85+ display-name: "Prefix ID"
86+ description:
87+ - "This is to show an example Prefix!"
88+ - "This is a second line of description!"
89+ prefix: "<white>[<rainbow>Something</rainbow>]</white>"
90+ verify-always: false
91+ show-when-locked: true
92+ requirements:
93+ - "permission simpleprefix.example true"
94+ - "statistic PLAYER_KILLS >= 10"
95+ - "advancement nether/summon_wither true"
96+ - "compare_int %placeholder% < 1"
97+ ` ` `
9498
9599` prefix-id`
96100> This is the Prefix ID. Every prefix is uniquely identified by this value.
@@ -125,11 +129,11 @@ These requirements come in multiple forms that will be explained here.
125129> Requirements that are incorrectly formatted or produce errors are ignored.
126130>
127131> Requirements that cannot guarantee failure will not be checked either.
128- > > To check player permissions, the player has to be online,
129- > > so while the player is offline, these checks are ignored.
132+ > To check player permissions, the player has to be online,
133+ > so while the player is offline, these checks are ignored.
130134>
131135> `verify-always` will make the requirements check every time the player's prefix is requested.
132- > > If the requirement check fails, the prefix saved is cleared.
136+ > If the requirement check fails, the prefix saved is cleared.
133137
134138<u>**Permission**</u>
135139
@@ -139,7 +143,7 @@ Format: `permission <permission.node> [false]`
139143> `<permission.node>` represents a permission the player may have.
140144>
141145> `[false]` is optional and must be provided to invert the result.
142- > > This means if the permission is `example.permission`, the player must NOT have this permission.
146+ > This means if the permission is `example.permission`, the player must NOT have this permission.
143147>
144148> <u>Example</u>: `permission example.permission` (Player has permission example.permission)
145149>
@@ -154,7 +158,7 @@ Format: `statistic <statistic> <operator> <value>`
154158> This represents some statistic the player has.
155159>
156160> `<operator>` is a comparison operator.
157- > > Valid operators are `>`, `<`, `>=`, `<=`, `==`, `!=`
161+ > Valid operators are `>`, `<`, `>=`, `<=`, `==`, `!=`
158162>
159163> `<value>` is an integer and can be compared to the statistic.
160164>
@@ -165,11 +169,12 @@ Format: `statistic <statistic> <operator> <value>`
165169Format : ` advancement <namespace:advancement> [false]`
166170
167171> `<namespace:advancement>` is a Namespaced Key representing an Advancement.
168- > > You can find vanilla advancements on [this page](https://minecraft.fandom.com/wiki/Advancement).
169- > > This represents some advancement the player can earn. Minecraft Advancements use the `minecraft` namespace.
172+ >
173+ > You can find vanilla advancements on [this page](https://minecraft.fandom.com/wiki/Advancement).
174+ > This represents some advancement the player can earn. Minecraft Advancements use the `minecraft` namespace.
170175>
171176> `[false]` is optional and must be provided to invert the result.
172- > > This means that if the advancement is `minecraft:nether/summon_wither`, the player must not have this advancement.
177+ > This means that if the advancement is `minecraft:nether/summon_wither`, the player must not have this advancement.
173178>
174179> <u>Example</u>: `advancement minecraft:nether/summon_wither` (Player has the Minecraft Summon Wither advancement).
175180>
@@ -182,7 +187,7 @@ Format: `compare_int <placeholder> <operator> <value>`
182187> `<placeholder>` is any PlaceholderAPI placeholder that can return a valid integer.
183188>
184189> `<operator>` is a comparison operator.
185- > > Valid operators are `>`, `<`, `>=`, `<=`, `==`, `!=`
190+ > Valid operators are `>`, `<`, `>=`, `<=`, `==`, `!=`
186191>
187192> `<value>` is an integer and can be compared to the placeholder.
188193>
@@ -195,6 +200,5 @@ Format: `compare_int <placeholder> <operator> <value>`
195200
196201# # WIP Features
197202
198- - Chest GUI
199203- Configurable Icons
200- - Requirement Checks
204+ - Compare String, Requirement Checks
0 commit comments