diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-05 20:54:36 +0100 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2023-07-05 20:54:36 +0100 |
| commit | 467715dcb3ee23e05e8fe445d9e2a2416a26a8e0 (patch) | |
| tree | eb1e61d15312f931b6f61d104dd63614a2620db4 /docs/Custom-GUI-items.md | |
| parent | 7e2e0f3c373c2108b8b3903675eac950b0e21307 (diff) | |
Migrate docs to GitHub pages
Diffstat (limited to 'docs/Custom-GUI-items.md')
| -rw-r--r-- | docs/Custom-GUI-items.md | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/docs/Custom-GUI-items.md b/docs/Custom-GUI-items.md deleted file mode 100644 index 97cc27f1..00000000 --- a/docs/Custom-GUI-items.md +++ /dev/null @@ -1,61 +0,0 @@ -**Custom GUI items** are dummy items added to the category menu and the -quest menu. This can be used to help stylise your quests GUI. - -This can be done in the `config.yml`: - -``` yaml -custom-elements: - "categories": # apply to the categories menu (the main menu by default) - 0: # <--- slot 1, note the slots start from 0! so 0 = slot 1 in this case - display: - name: "&cExample Custom Item (slot 1)" - lore: - - "&7This is a custom item which can be added" - - "&7to your menus. This is purely cosmetic." - - "" - - "&7Two empty slots should follow." - type: "DIAMOND_BLOCK" - 1: # <--- start from slot 2 - spacer: true # empty slot in GUI - repeat: 2 # repeats for 2 slots - 3: # <--- start from slot 4 - display: - name: "&cExample Custom Item (slots 4 - 7)" - lore: - - "&7This is a custom item which can be added" - - "&7to your menus, but in slot 4 and repeated" - - "&73 times." - - "&7" - - "&7This will come after 2 empty slots." - - "&7" - - "&7This is purely cosmetic." - type: "NETHERRACK" - repeat: 3 # repeats for 3 more slots - commands: - - "this command will be executed if the player click on this item" -``` - -The optional `repeat` field will repeat the item for consecutive slots -after that. - -The optional `commands` list will execute commands if the player clicks -on the item. The `{player}` placeholder can be used to substitute the -player name. - -These custom elements take precedence over quest items, as quests and -categories will fill empty slots once all the custom items have been -set. - -<https://i.imgur.com/5odcqM9.png> - -To add a custom item within the quest menu itself, you must specify the -category, or if categories are disabled you can specify "quests" -instead: - -``` yaml -custom-elements: - "c:<category-name>": # apply to <category-name> menu - ... - "quests": # apply to whole quests menu if categories are disabled - ... -``` |
