aboutsummaryrefslogtreecommitdiffstats
path: root/docs/GUI-configuration.md
diff options
context:
space:
mode:
authorLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-05 20:54:36 +0100
committerLMBishop <13875753+LMBishop@users.noreply.github.com>2023-07-05 20:54:36 +0100
commit467715dcb3ee23e05e8fe445d9e2a2416a26a8e0 (patch)
treeeb1e61d15312f931b6f61d104dd63614a2620db4 /docs/GUI-configuration.md
parent7e2e0f3c373c2108b8b3903675eac950b0e21307 (diff)
Migrate docs to GitHub pages
Diffstat (limited to 'docs/GUI-configuration.md')
-rw-r--r--docs/GUI-configuration.md262
1 files changed, 0 insertions, 262 deletions
diff --git a/docs/GUI-configuration.md b/docs/GUI-configuration.md
deleted file mode 100644
index fb63d1f1..00000000
--- a/docs/GUI-configuration.md
+++ /dev/null
@@ -1,262 +0,0 @@
-
-*See also [Custom GUI items](Custom_GUI_items "wikilink") and [Defining
-items](Defining_items "wikilink").*
-
-The **GUI configuration** is defined in the `config.yml`. These define
-the static UI elements such as the back button, quest locked display
-etc. All options accept the standard ItemStack definition format
-described in [Defining items](Defining_items "wikilink").
-
-## Back button
-
-
-*`gui.back-button`*
-
-The back button displayed within sub menus.
-
-``` yaml
-gui:
- ...
- back-button:
- name: "&cReturn"
- lore:
- - "&7Return to the categories menu."
- type: "ARROW"
-```
-
-## Page previous
-
-
-*`gui.page-prev`*
-
-The previous page button displayed on paiginated menus.
-
-``` yaml
-gui:
- ...
- page-prev:
- name: "&7Previous Page"
- lore:
- - "&7Switch the page to page &c{prevpage}."
- type: "FEATHER"
-```
-
-The `{prevpage}` variable represents the page number for the previous
-page.
-
-## Page next
-
-
-*`gui.page-next`*
-
-The next page button displayed on paiginated menus.
-
-``` yaml
-gui:
- ...
- page-next:
- name: "&7Next Page"
- lore:
- - "&7Switch the page to page &c{nextpage}."
- type: "FEATHER"
-```
-
-The `{nextpage}` variable represents the page number for the next page.
-
-## Page description
-
-
-*`gui.page-next`*
-
-The current page item displayed on paginated menus. The amount of this
-item will automatically update on the page number.
-
-``` yaml
-gui:
- ...
- page-desc:
- name: "&7Page &c{page}"
- lore:
- - "&7You are currently viewing page &c{page}."
- type: "PAPER"
-```
-
-The `{page}` variable represents the page number for the current page.
-
-## Quest locked display
-
-
-*`gui.quest-locked-display`*
-
-The item is used to represent locked quests. A quest is locked if its
-[requirements](Creating_a_quest#Requirements "wikilink") are not met.
-
-``` yaml
-gui:
- ...
- quest-locked-display:
- name: "&c&lQuest Locked"
- lore:
- - "&7You have not completed the requirements"
- - "&7for this quest (&c{quest}&7)."
- - ""
- - "&7Requires: &c{requirements}"
- - "&7to be completed to unlock."
- type: "RED_STAINED_GLASS_PANE"
-```
-
-The `{quest}` variable represents the quest [display
-name](Creating_a_quest#name "wikilink"), with its formatting stripped.
-
-The `{questid}` variable represents the quest ID.
-
-The `{requirements}` variable represents the display names of the quests
-needed to unlock this quest. By default, this name is truncated to show
-only the first quest, with a number after (e.g. "Example II +4 more").
-This behaviour is defined at [Basic options ยง GUI-truncate
-requirements](Basic-options#GUI-truncate-requirements "wikilink")
-
-## Quest permission display
-
-
-*`gui.quest-permission-display`*
-
-The item is used to represent quests which the player does not have
-permission to start.
-
-``` yaml
-gui:
- ...
- quest-permission-display:
- name: "&6&lNo Permission"
- lore:
- - "&7You do not have permission for this"
- - "&7quest (&6{quest}&7)."
- type: "BROWN_STAINED_GLASS_PANE"
-```
-
-The `{quest}` variable represents the quest [display
-name](Creating_a_quest#name "wikilink"), with its formatting stripped.
-
-The `{questid}` variable represents the quest ID.
-
-## Quest cooldown display
-
-
-*`gui.quest-cooldown-display`*
-
-The item is used to represent quests which are repeatable, the player
-has completed, but are on cooldown.
-
-``` yaml
-gui:
- ...
- quest-cooldown-display:
- name: "&e&lQuest On Cooldown"
- lore:
- - "&7You have recently completed this quest"
- - "&7(&e{quest}&7) and you must"
- - "&7wait another &e{time} &7to unlock again."
- type: "ORANGE_STAINED_GLASS_PANE"
-```
-
-The `{quest}` variable represents the quest [display
-name](Creating_a_quest#name "wikilink"), with its formatting stripped.
-
-The `{questid}` variable represents the quest ID.
-
-The `{time}` variable represents the formatted time remaining until the
-cooldown period is over. This can be configured in the messages section.
-
-## Quest completed display
-
-
-*`gui.quest-completed-display`*
-
-The item is used to represent quests which are completed and not
-repeatable.
-
-``` yaml
-gui:
- ...
- quest-completed-display:
- name: "&a&lQuest Complete"
- lore:
- - "&7You have completed this quest"
- - "&7(&a{quest}&7) and cannot."
- - "&7repeat it."
- type: "GREEN_STAINED_GLASS_PANE"
-```
-
-The `{quest}` variable represents the quest [display
-name](Creating_a_quest#name "wikilink"), with its formatting stripped.
-
-The `{questid}` variable represents the quest ID.
-
-## No started quests
-
-
-*`gui.no-started-quests`*
-
-This is shown as the only item in the quest started menu if the player
-has not started any quests.
-
-``` yaml
-gui:
- ...
- no-started-quests:
- name: "&c&lNo Started Quests"
- lore:
- - "&7Go start some!"
- type: "FEATHER"
-```
-
-## Quest cancel yes
-
-
-*`gui.quest-cancel-yes`*
-
-Confirmation item in the quest cancel menu.
-
-``` yaml
-gui:
- ...
- quest-cancel-yes:
- name: "&a&lConfirm Cancel"
- lore:
- - "&7Confirm you wish to cancel"
- - "&7this quest and lose all"
- - "&7progress."
- type: "GREEN_STAINED_GLASS_PANE"
-```
-
-## Quest cancel no
-
-
-*`gui.quest-cancel-no`*
-
-Cancellation item in the quest cancel menu.
-
-``` yaml
-gui:
- ...
- quest-cancel-no:
- name: "&c&lAbort Cancel"
- lore:
- - "&7Return to the quest menu."
- type: "RED_STAINED_GLASS_PANE"
-```
-
-## Quest cancel background
-
-
-*`gui.quest-cancel-background`*
-
-Background item in the quest cancel menu.
-
-``` yaml
-gui:
- ...
- quest-cancel-background:
- type: "GRAY_STAINED_GLASS_PANE"
-```