Skip to content

Commit 1dca48c

Browse files
committed
Add Docs on Header Item Config
1 parent 9f74a3d commit 1dca48c

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

Diff for: README.md

+52
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,13 @@ A plugin aiming to allow for simple player-selected prefixes that can be used in
5252
saving-type: "file"
5353
default-prefix: "<white>[<gray>Player</gray>]</white> "
5454
prefix-menu-name: "<bold>Prefix Menu</bold>"
55+
56+
header:
57+
name: "<aqua>Click to Reset Your Prefix</aqua>"
58+
lore: []
59+
material: ENDER_EYE
60+
count: 1
61+
custom-model-data: null
5562
```
5663
5764
## Configuration Settings
@@ -61,6 +68,7 @@ prefix-menu-name: "<bold>Prefix Menu</bold>"
6168
| saving-type | What type of saving system should this use? | `PDC`, `FILE` |
6269
| default-prefix | Fallback prefix, supports Placeholders. | String |
6370
| prefix-menu-name | The name of the prefix menu. | String |
71+
| header | Section for Header Item Configuration | *See Below* |
6472

6573
### Saving Types
6674

@@ -79,6 +87,50 @@ __YML File (FILE)__
7987
>
8088
> This is default.
8189

90+
### Header Configuration
91+
92+
The prefix menu header is configurable in multiple ways.
93+
94+
```yaml
95+
header:
96+
name: "<aqua>Click to Reset Your Prefix</aqua>"
97+
lore: []
98+
material: ENDER_EYE
99+
count: 1
100+
custom-model-data: null
101+
```
102+
103+
__Name__
104+
> This is a String representing the item's name.
105+
>
106+
> Defaults to "Click to Reset Your Prefix".
107+
>
108+
> Mini-Message and Placeholders are supported.
109+
110+
__Lore__
111+
> This is a list of Strings representing each lore line.
112+
>
113+
> Defaults to an empty list.
114+
>
115+
> Mini-Message and Placeholders are supported.
116+
117+
__Material__
118+
> This is a String representing the Material Enumerated Type from [Paper Material Enum](https://jd.papermc.io/paper/1.20/org/bukkit/Material.html)
119+
>
120+
> Invalid or missing values defaults to ENDER_EYE (Eye of Ender).
121+
122+
__Count__
123+
> This is a String / Integer representing the item stack quantity.
124+
>
125+
> Invalid or missing values defaults to 1. Do not set to 0.
126+
>
127+
> Placeholders are supported, so long as they become an int representation.
128+
129+
__Custom Model Data__
130+
> This is an integer that represents the custom model data.
131+
>
132+
> Invalid or missing value leaves the item unchanged.
133+
82134
## Creating Prefixes
83135

84136
Prefixes are stored in the `prefixes.yml` file, this is the default.

0 commit comments

Comments
 (0)