Skip to content

Commit ef13de7

Browse files
Update README.md
Added documentation for new features.
1 parent a590ed7 commit ef13de7

1 file changed

Lines changed: 47 additions & 12 deletions

File tree

README.md

Lines changed: 47 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ A plugin aiming to allow for simple player-selected prefixes that can be used in
1212

1313
# Features
1414

15-
<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%>
15+
<img src='https://user-images.githubusercontent.com/20095065/215312375-0cb1f307-2eae-43c4-bbf9-2b306bad5952.png' width=30%> <img src='https://user-images.githubusercontent.com/20095065/215312448-666f183a-d6a8-4aa0-a643-6694ff52b670.png' width=30%>
16+
<img src='https://github.com/Simplexity-Development/SimplePrefixes/assets/20095065/f6b57b7a-7d2b-4e24-9422-b5ede0cf589e' width=30%>
1617

1718
- Player friendly GUI for selecting nicknames.
1819
- Does not interact with any other plugins directly.
@@ -50,14 +51,16 @@ A plugin aiming to allow for simple player-selected prefixes that can be used in
5051
```yml
5152
saving-type: "file"
5253
default-prefix: "<white>[<gray>Player</gray>]</white> "
54+
prefix-menu-name: "<bold>Prefix Menu</bold>"
5355
```
5456
5557
## Configuration Settings
5658
57-
| Setting | Description | Valid Values |
58-
|----------------|---------------------------------------------|---------------|
59-
| saving-type | What type of saving system should this use? | `PDC`, `FILE` |
60-
| default-prefix | Fallback prefix, supports Placeholders. | String |
59+
| Setting | Description | Valid Values |
60+
|------------------|---------------------------------------------|---------------|
61+
| saving-type | What type of saving system should this use? | `PDC`, `FILE` |
62+
| default-prefix | Fallback prefix, supports Placeholders. | String |
63+
| prefix-menu-name | The name of the prefix menu. | String |
6164

6265
### Saving Types
6366

@@ -120,27 +123,59 @@ wither_hunter:
120123
show-when-locked: false
121124
requirements:
122125
- "advancement minecraft:nether/summon_wither"
126+
custom_model_data:
127+
display-name: "<aqua>Bucket Mobs!</aqua>"
128+
description:
129+
- "If you have SimpleBucketMobs' resource pack"
130+
- "then this is an Enderman Bucket!"
131+
prefix: "<white>[<aqua>Simple Bucket Mobs</aqua>]</white>"
132+
item:
133+
material: BUCKET
134+
count: 2
135+
custom-model-data: 22000
123136
```
124137

125-
Prefix ID
138+
Prefix ID **[Required]**
126139
> This is the Prefix ID. Every prefix is uniquely identified by this value.
127140
>
128141
> This does mean you cannot have two of the same Prefix IDs.
129142

130-
Display Name (`display-name`)
143+
Display Name (`display-name`) **[Required]**
131144
> This is the Display Name of the prefix. It is the formal name of the prefix.
132145
>
133146
> Supports Placeholders from PlaceholderAPI.
134147

148+
Prefix (`prefix`) **[Required]**
149+
> This is the String representation of the prefix that will be displayed in place of `%sp_prefix%` / `%sp_prefix_legacy%`.
150+
>
151+
> Supports Placeholders from PlaceholderAPI.
152+
135153
Description (`description`)
136154
> This is a list of strings. Each string will be a new line in the description part of the GUI.
137155
>
138156
> Supports Placeholders from PlaceholderAPI.
139157

140-
Prefix (`prefix`)
141-
> This is the String representation of the prefix that will be displayed in place of `%sp_prefix%` / `%sp_prefix_legacy%`.
158+
Item (`item`)
159+
> This is a way to define your item stacks.
160+
>
161+
> - `material` defines the material of the item. Invalid or missing defaults to `NAME_TAG`. [Paper Material Enum](https://jd.papermc.io/paper/1.20/org/bukkit/Material.html)
162+
> - `count` changes the stack size (the number of items in the stack). Invalid or missing defaults to `1`.
163+
> - `custom-model-data` changes the custom model data, used for Resource Packs. Invalid or missing leaves the item unchanged.
164+
>
165+
> If this section is missing, the itemstack is defaulted to a single name tag.
166+
167+
Show When Locked (`show-when-locked`)
168+
> If this is true, the prefix will not show in the menu if the requirements are not met.
142169
>
143-
> Supports Placeholders from PlaceholderAPI.
170+
> This defaults to `true`.
171+
172+
Verify Always (`verify-always`)
173+
> Checks the requirements each time the player's prefix is requested by PAPI.
174+
> If the check fails, the player's prefix is cleared.
175+
>
176+
> This defaults to `false`.
177+
178+
### Minimum Configuration for a Prefix
144179

145180
```yml
146181
# A prefix with the ID "example-prefix"...
@@ -151,7 +186,7 @@ example-prefix:
151186

152187
### Prefix Requirements
153188

154-
Requirements are things that must be held true in order to equip the prefix.
189+
Requirements are conditions that must be held true in order to equip the prefix.
155190
These requirements come in multiple forms that will be explained here.
156191

157192
> **Note**
@@ -230,6 +265,6 @@ Format: `compare_int <placeholder> <operator> <value>`
230265

231266
## WIP Features
232267

233-
- Configurable Icons
268+
- Special Configurable Icons (ie: Player Heads)
234269
- Compare String, Requirement Checks
235270
- "Live Now" Livestreaming Implementation

0 commit comments

Comments
 (0)