diff options
Diffstat (limited to 'docs/configuration')
| -rw-r--r-- | docs/configuration/basic-options.md | 94 | ||||
| -rw-r--r-- | docs/configuration/colour-codes.md | 56 | ||||
| -rw-r--r-- | docs/configuration/configuration-problems.md | 4 | ||||
| -rw-r--r-- | docs/configuration/creating-a-quest.md | 56 | ||||
| -rw-r--r-- | docs/configuration/custom-gui-items.md | 4 | ||||
| -rw-r--r-- | docs/configuration/defining-items.md | 51 | ||||
| -rw-r--r-- | docs/configuration/global-configurations.md | 10 | ||||
| -rw-r--r-- | docs/configuration/gui-configuration.md | 42 | ||||
| -rw-r--r-- | docs/configuration/storage-providers.md | 12 |
9 files changed, 165 insertions, 164 deletions
diff --git a/docs/configuration/basic-options.md b/docs/configuration/basic-options.md index 24927b12..0a2dbdc0 100644 --- a/docs/configuration/basic-options.md +++ b/docs/configuration/basic-options.md @@ -39,7 +39,7 @@ only helping determine the order they are sorted. ``` yaml options: - ... + # ... categories-enabled: true ``` @@ -53,7 +53,7 @@ of rows) so that there are not any empty rows. ``` yaml options: - ... + # ... trim-gui-size: true ``` @@ -67,7 +67,7 @@ quests. ``` yaml options: - ... + # ... titles-enabled: true ``` @@ -77,18 +77,18 @@ options: {: .warning } **This option has been removed in version 3.8 and this wiki entry is -subject to removal.** Please see [quest limit](#quest-limit "wikilink") +subject to removal.** Please see [quest limit](#quest-limit) instead. Choose the number of quests players can start at one time. This will include quests which have [quest-specific -autostart](Creating_a_quest#Autostart "wikilink") enabled, however this +autostart](creating-a-quest#autostart) enabled, however this value will be ignored if [global -`quest-autostart`](Basic_options#Quest_autostart "wikilink") is enabled. +`quest-autostart`](#quest-autostart) is enabled. ``` yaml options: - ... + # ... quest-started-limit: 2 ``` @@ -99,9 +99,9 @@ options: Choose the number of quests players can start at one time. This will include quests which have [quest-specific -autostart](Creating_a_quest#Autostart "wikilink") enabled, however this +autostart](creating-a-quest#autostart) enabled, however this value will be ignored if [global -`quest-autostart`](Basic_options#Quest_autostart "wikilink") is enabled. +`quest-autostart`](#quest-autostart) is enabled. Each key is called a **limit group** (sometimes referred to as a quest rank), and players can start the set number of quests depending on their @@ -111,7 +111,7 @@ to everybody, however the rest can be granted through the permission ``` yaml options: - ... + # ... quest-limit: default: 2 group1: 5 @@ -120,7 +120,7 @@ options: ``` Group permissions are also documented in [Commands and permissions § -Permissions](commands-and-permissions#permissions "wikilink"). +Permissions](../commands-and-permissions#permissions). ## Allow quest cancel @@ -131,11 +131,11 @@ Choose whether or not players can cancel quests themselves via command or by right-clicking in the GUI. If this is set to false, consider removing the right-click cancel instruction from the [global quest display -configuration](Global_configurations#Global_quest_display_configuration "wikilink"). +configuration](global-configurations#global-quest-display-configuration). ``` yaml options: - ... + # ... allow-quest-cancel: true ``` @@ -148,11 +148,11 @@ Choose whether or not players can track quests themselves via command or by middle-clicking in the GUI. If this is set to false, consider removing the middle-click track instruction from the [global quest display -configuration](Global_configurations#Global_quest_display_configuration "wikilink"). +configuration](global-configurations#global-quest-display-configuration). ``` yaml options: - ... + # ... allow-quest-track: true ``` @@ -168,7 +168,7 @@ leading to errors. ``` yaml options: - ... + # ... task-type-exclusions: [] ``` @@ -176,7 +176,7 @@ options: ``` yaml options: - ... + # ... task-type-exclusions: - "blockbreak" - "blockbreakcertain" @@ -191,7 +191,7 @@ Change and define specific GUI names for localization. ``` yaml options: - ... + # ... guinames: quests-category: "Quests Categories" quests-menu: "Quests" @@ -209,7 +209,7 @@ Choose which sounds play at certain events. ``` yaml options: - ... + # ... sounds: quest-start: "ENTITY_PLAYER_LEVELUP:2:3" quest-cancel: "UI_TOAST_OUT:2:3" @@ -230,7 +230,7 @@ for example: ``` yaml options: - ... + # ... sounds: quest-start: "" ``` @@ -254,7 +254,7 @@ or not. ``` yaml options: - ... + # ... gui-hide-locked: false ``` @@ -269,7 +269,7 @@ screen. ``` yaml options: - ... + # ... gui-confirm-cancel: true ``` @@ -283,7 +283,7 @@ have permission for the quest. ``` yaml options: - ... + # ... gui-hide-quests-nopermission: false ``` @@ -297,7 +297,7 @@ have permission for the category. ``` yaml options: - ... + # ... gui-hide-categories-nopermission: false ``` @@ -311,7 +311,7 @@ is disabled by default for performance reasons. ``` yaml options: - ... + # ... gui-use-placeholderapi: false ``` @@ -327,7 +327,7 @@ the requirement, rather than listing each quest "Quest 1, Quest 2, Quest ``` yaml options: - ... + # ... gui-truncate-requirements: true ``` @@ -342,7 +342,7 @@ page](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/event/inventory/ClickT ``` yaml options: - ... + # ... gui-actions: start-quest: "LEFT" track-quest: "MIDDLE" @@ -356,12 +356,12 @@ options: Choose whether or not players need to start quests themselves. This will ignore the configured [quest started -limit](#Quest_started_limit "wikilink"), and is different from the -[autostart](#Autostart "wikilink") option. +limit](#quest-started-limit), and is different from the +[autostart](#quest-autostart) option. ``` yaml options: - ... + # ... quest-autostart: false ``` @@ -377,7 +377,7 @@ quest. ``` yaml options: - ... + # ... quest-autotrack: true ``` @@ -392,7 +392,7 @@ output based on the following options: 0 = errors only, 1 = warnings, 2 ``` yaml options: - ... + # ... verbose-logging-level: 2 ``` @@ -407,7 +407,7 @@ default for performance reasons. ``` yaml options: - ... + # ... quests-use-placeholderapi: false ``` @@ -426,7 +426,7 @@ progress. ``` yaml options: - ... + # ... verify-quest-exists-on-load: true ``` @@ -451,7 +451,7 @@ These options are measured in ticks, 1 second = 20 ticks. ``` yaml options: - ... + # ... performance-tweaking: quest-queue-executor-interval: 1 quest-autosave-interval: 12000 @@ -470,7 +470,7 @@ permission.) ``` yaml options: - ... + # ... tab-completion: enabled: true ``` @@ -482,13 +482,13 @@ options: Configure how Quests handles errors in your configuration. By default, Quests will not allow quests to be loaded if they contain an -[error](Configuration_problems#Types_of_problem "wikilink"), since this +[error](configuration-problems#types-of-problem), since this could lead to undefined behaviour. The option `override-errors` will ignore this behaviour and forcibly allow the quest to be registered. ``` yaml options: - ... + # ... error-checking: override-errors: false ``` @@ -496,16 +496,16 @@ options: ## Placeholder cache time -''`options.placeholder-cache-time`" +*`options.placeholder-cache-time`* Set how long Quests will retain parsed PlaceholderAPI strings in the cache, in seconds. See [PlaceholderAPI § Caching -placeholders](PlaceholderAPI#Caching_placeholders "wikilink") for more +placeholders](../tools/placeholderapi#caching-placeholders) for more information. ``` yaml options: - ... + # ... placeholder-cache-time: 10 ``` @@ -515,12 +515,12 @@ options: *`options.global-task-configuration-override`* Choose whether or not options set in the [global task -configuration](Global_configurations#Global_task_configuration "wikilink") +configuration](global-configurations#global-task-configuration) will override per-quest specific options. ``` yaml options: - ... + # ... global-task-configuration-override: false ``` @@ -530,12 +530,12 @@ options: *`options.global-quest-display-configuration-override`* Choose whether or not the [global quest display -configuration](Global_configurations#Global_quest_display_configuration "wikilink") +configuration](global-configurations#global-quest-display-configuration) will override per-quest specific options. ``` yaml options: - ... + # ... global-quest-display-configuration-override: false ``` @@ -545,11 +545,11 @@ options: *`options.storage`* Configure how Quests will store playerdata. See [storage -providers](Storage_providers "wikilink") for more info. +providers](storage-providers) for more info. ``` yaml options: - ... + # ... storage: provider: "yaml" synchronisation: diff --git a/docs/configuration/colour-codes.md b/docs/configuration/colour-codes.md index 6c7339c0..0d3de95d 100644 --- a/docs/configuration/colour-codes.md +++ b/docs/configuration/colour-codes.md @@ -9,38 +9,38 @@ You can use colour codes anywhere the plugin accepts a message (plugin messages, The following table shows the colour capabilities of specific server versions: -| | Before 1.16 | 1.16+ | -| ---- | ---- | ---- | -| Colour Codes | ✔️ | ✔️ | -| Hexadecimal | ❌ | ✔️ | +| | Before 1.16 | 1.16+ | +|--------------|-------------|-------| +| Colour Codes | ✔️ | ✔️ | +| Hexadecimal | ❌ | ✔️ | ## Colour codes The plugin will automatically translate colour codes from '&' to '§' for you. -| Name | Chat Code | Hex Equivalent | -| ---- | ---- | ---- | -| Black | `&0` | #000000 | -| Dark Blue | `&1` | #0000AA | -| Dark Green | `&2` | #00AA00 | -| Dark Aqua | `&3` | #00AAAA | -| Dark Red | `&4` | #AA0000 | -| Dark Purple | `&5` | #AA00AA | -| Gold | `&6` | #FFAA00 | -| Gray | `&7` | #AAAAAA | -| Dark Gray | `&8` | #555555 | -| Blue | `&9` | #5555FF | -| Green | `&a` | #55FF55 | -| Aqua | `&b` | #55FFFF | -| Red | `&c` | #FF5555 | -| Light Purple | `&d` | #FF55FF | -| Yellow | `&e` | #FFFF55 | -| White | `&f` | #FFFFFF | -| Obfuscated | `&k` | - | -| Bold | `&l` | - | -| Strikethrough | `&m` | - | -| Underline | `&n` | - | -| Italic | `&o` | - | -| Reset | `&r` | - | +| Name | Chat Code | Hex Equivalent | +|---------------|-----------|----------------| +| Black | `&0` | #000000 | +| Dark Blue | `&1` | #0000AA | +| Dark Green | `&2` | #00AA00 | +| Dark Aqua | `&3` | #00AAAA | +| Dark Red | `&4` | #AA0000 | +| Dark Purple | `&5` | #AA00AA | +| Gold | `&6` | #FFAA00 | +| Gray | `&7` | #AAAAAA | +| Dark Gray | `&8` | #555555 | +| Blue | `&9` | #5555FF | +| Green | `&a` | #55FF55 | +| Aqua | `&b` | #55FFFF | +| Red | `&c` | #FF5555 | +| Light Purple | `&d` | #FF55FF | +| Yellow | `&e` | #FFFF55 | +| White | `&f` | #FFFFFF | +| Obfuscated | `&k` | - | +| Bold | `&l` | - | +| Strikethrough | `&m` | - | +| Underline | `&n` | - | +| Italic | `&o` | - | +| Reset | `&r` | - | ## Hexadecimal colour For compatible Minecraft versions, the plugin will also translate hex colour codes for you. diff --git a/docs/configuration/configuration-problems.md b/docs/configuration/configuration-problems.md index a55bbfde..8457a785 100644 --- a/docs/configuration/configuration-problems.md +++ b/docs/configuration/configuration-problems.md @@ -89,8 +89,8 @@ tasks: type: "inventory" amount: 10 item: DIAMOND -... +# ... options: # requirements section removed - ... + # ... ```
\ No newline at end of file diff --git a/docs/configuration/creating-a-quest.md b/docs/configuration/creating-a-quest.md index 6e3b7283..4e7353a6 100644 --- a/docs/configuration/creating-a-quest.md +++ b/docs/configuration/creating-a-quest.md @@ -37,7 +37,7 @@ Simalar to quest IDs, there are task IDs. They can be identical to the quest ID but must be unique to each other. For help on adding the tasks, refer to [task configuration -layout](Task_configuration_layout "wikilink") +layout](../task-types) ## Display @@ -93,7 +93,7 @@ is complete. ``` yaml display: - ... + # ... lore-started: - "" - "&7Your current progression:" @@ -109,7 +109,7 @@ The type (material name) of item. ``` yaml display: - ... + # ... type: "WOODEN_PICKAXE" ``` @@ -187,7 +187,7 @@ placeholders: ``` These placeholders will be called using PlaceholderAPI. See [quest -progress in scoreboard](Quest_progress_in_scoreboard "wikilink") for a +progress in scoreboard](../guides/quest-progress-in-scoreboard) for a guide which utilises this feature. ## Options @@ -207,7 +207,7 @@ of the category here. ``` yaml options: - ... + # ... category: "example" ``` @@ -221,7 +221,7 @@ able to start this quest. ``` yaml options: - ... + # ... requires: - "quest-id" ``` @@ -236,7 +236,7 @@ start. The permission will be `quests.quest.<id>`. ``` yaml options: - ... + # ... permission-required: false ``` @@ -251,7 +251,7 @@ then this option is ignored. ``` yaml options: - ... + # ... cancellable: false ``` @@ -266,7 +266,7 @@ effect as quest limits are disabled. ``` yaml options: - ... + # ... counts-towards-limit: false ``` @@ -279,7 +279,7 @@ options: ``` yaml options: - ... + # ... repeatable: false ``` @@ -293,7 +293,7 @@ immediately replayable. ``` yaml options: - ... + # ... cooldown: enabled: true time: 1440 # minutes @@ -310,7 +310,7 @@ reset. ``` yaml options: - ... + # ... time-limit: enabled: true time: 1440 # minutes @@ -326,7 +326,7 @@ come first. ``` yaml options: - ... + # ... sort-order: 1 ``` @@ -341,12 +341,12 @@ specific only to this quest, meaning it cannot be cancelled and counts towards the players quest started limit. See [§ counts towards -limit](Creating_a_quest#Counts_towards_limit "wikilink") if you do not +limit](#counts-towards-limit) if you do not want autostart quests to count towards the quest started limit. ``` yaml options: - ... + # ... autostart: true ``` @@ -357,14 +357,14 @@ options: **Optional.** The display item this quest should take if it is completed. This accepts the standard ItemStack definition format -described in [Defining items](Defining_items "wikilink"). If this option +described in [defining items](defining-items.md). If this option is not specified, the display item [defined in the main -config.yml](gui-configuration#quest-completed-display "wikilink") will +config.yml](gui-configuration#quest-completed-display) will be used. ``` yaml options: - ... + # ... completed-display: type: "STEAK" ``` @@ -376,14 +376,14 @@ options: **Optional.** The display item this quest should take if it is on cooldown. This accepts the standard ItemStack definition format -described in [Defining items](Defining_items "wikilink"). If this option +described in [defining items](defining-items). If this option is not specified, the display item [defined in the main -config.yml](gui-configuration#quest-cooldown-display "wikilink") will be +config.yml](gui-configuration#quest-cooldown-display) will be used. ``` yaml options: - ... + # ... cooldown-display: type: "STEAK" ``` @@ -395,15 +395,15 @@ options: **Optional.** The display item this quest should take if the player does not have permission to start it. This accepts the standard ItemStack -definition format described in [Defining -items](Defining_items "wikilink"). If this option is not specified, the +definition format described in [defining +items](defining-items). If this option is not specified, the display item [defined in the main -config.yml](gui-configuration#quest-permission-display "wikilink") will +config.yml](gui-configuration#quest-permission-display) will be used. ``` yaml options: - ... + # ... permission-display: type: "STEAK" ``` @@ -415,14 +415,14 @@ options: **Optional.** The display item this quest should take if the player has not unlocked it. This accepts the standard ItemStack definition format -described in [Defining items](Defining_items "wikilink"). If this option +described in [defining items](defining-items). If this option is not specified, the display item [defined in the main -config.yml](gui-configuration#quest-locked-display "wikilink") will be +config.yml](gui-configuration#quest-locked-display) will be used. ``` yaml options: - ... + # ... locked-display: type: "STEAK" ``` diff --git a/docs/configuration/custom-gui-items.md b/docs/configuration/custom-gui-items.md index 3ce97b15..f7a2bbac 100644 --- a/docs/configuration/custom-gui-items.md +++ b/docs/configuration/custom-gui-items.md @@ -62,7 +62,7 @@ instead: ``` yaml custom-elements: "c:<category-name>": # apply to <category-name> menu - ... + # ... "quests": # apply to whole quests menu if categories are disabled - ... + # ... ``` diff --git a/docs/configuration/defining-items.md b/docs/configuration/defining-items.md index fddec792..a32bb689 100644 --- a/docs/configuration/defining-items.md +++ b/docs/configuration/defining-items.md @@ -35,17 +35,17 @@ item: ## Options -| Field | Optional | Minecraft Version | More Information | -|----------------------|-----------------|-------------------|-----------------------------------------| -| `item` | ❌ | \- | [Jump](#item "wikilink") | -| `name` | ✅ <sup>\*</sup> | \- | [Jump](#name "wikilink") | -| `lore` | ✅ | \- | [Jump](#lore "wikilink") | -| `enchantments` | ✅ | \- | [Jump](#enchantments "wikilink") | -| `itemflags` | ✅ | 1.8+ | [Jump](#item-flags "wikilink") | -| `unbreakable` | ✅ | 1.13+ | [Jump](#unbreakable "wikilink") | -| `attributemodifiers` | ✅ | 1.13+ | [Jump](#attribute-modifiers "wikilink") | -| `custommodeldata` | ✅ | 1.14+ | [Jump](#custom-model-data "wikilink") | -| `owner-[...]` | ✅ | 1.8+ | [Jump](#owner "wikilink") | +| Field | Optional | Minecraft Version | More Information | +|----------------------|-----------------|-------------------|------------------------------| +| `item` | ❌ | \- | [Jump](#item) | +| `name` | ✅ <sup>\*</sup> | \- | [Jump](#name) | +| `lore` | ✅ | \- | [Jump](#lore) | +| `enchantments` | ✅ | \- | [Jump](#enchantments) | +| `itemflags` | ✅ | 1.8+ | [Jump](#item-flags) | +| `unbreakable` | ✅ | 1.13+ | [Jump](#unbreakable) | +| `attributemodifiers` | ✅ | 1.13+ | [Jump](#attribute-modifiers) | +| `custommodeldata` | ✅ | 1.14+ | [Jump](#custom-model-data) | +| `owner-[...]` | ✅ | 1.8+ | [Jump](#owner) | <sup>\*: The name must be defined for the display item of Quests.</sup> @@ -65,7 +65,7 @@ the end with a colon `:<code>`. ``` yaml item: item: "WHEAT" - ... + # ... ``` ### Name @@ -79,7 +79,7 @@ above the hotbar when selected. ``` yaml item: name: "&2&lSuper Cool Name" - ... + # ... ``` ### Lore @@ -95,7 +95,7 @@ item: lore: - "Line 1" - "Line 2" - ... + # ... ``` ### Enchantments @@ -114,7 +114,7 @@ names](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantm item: enchantments: - "minecraft:infinity:1" - ... + # ... ``` ### Item flags @@ -127,7 +127,7 @@ javadocs](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemFlag item: itemflags: - "HIDE_ATTRIBUTES" - ... + # ... ``` ### Unbreakable @@ -137,7 +137,7 @@ item: ``` yaml item: unbreakable: true - ... + # ... ``` ### Attribute modifiers @@ -166,7 +166,7 @@ item: operation: ADD_NUMBER amount: 0.01 equipmentslot: OFF_HAND - ... + # ... ``` ### Custom model data @@ -176,7 +176,7 @@ item: ``` yaml item: custommodeldata: 12345 - ... + # ... ``` ### Owner @@ -201,19 +201,19 @@ You can specify each type by the following: ``` yaml item: owner-base64: "base64 encoded string" - ... + # ... ``` ``` yaml item: owner-username: "username" - ... + # ... ``` ``` yaml item: owner-uuid: "uuid" - ... + # ... ``` ## Quest items @@ -239,7 +239,9 @@ run `/q a items import <id>`, where `<id>` is the desired name of the item. Your item will be saved to file items/\<id\>.yml, **with the type 'raw**'. -<https://i.imgur.com/6lsld61.png> <https://i.imgur.com/Pg2eO9a.png> +<img src="https://i.imgur.com/6lsld61.png" height=20> + +<img src="https://i.imgur.com/Pg2eO9a.png" height=40> ### Defining items @@ -250,8 +252,7 @@ items/ directory. You must specify a `type` and the item itself under #### Defined **Defined quest items** are regular ItemStacks and follow the format -defined under [§ Configurable -options](Defined_items#Configurable_options "wikilink"). +defined under [§ options](#options). items/testitem.yml diff --git a/docs/configuration/global-configurations.md b/docs/configuration/global-configurations.md index 6be6b744..65066d31 100644 --- a/docs/configuration/global-configurations.md +++ b/docs/configuration/global-configurations.md @@ -36,7 +36,7 @@ if they are coming from individual quests. Quest-level configurations will override anything set here. To change this behaviour, modify the [global task configuration -override](Basic_options#Global_task_configuration_override "wikilink"). +override](basic-options#global-task-configuration-override). ## Global quest display configuration @@ -77,7 +77,7 @@ You can define macros in your `config.yml`, under the `global-macros` section: global-macros: - ... + # ... # <name of macro>: <string value of macro> top-bar: "&6---&7---&6---" @@ -88,13 +88,13 @@ For example, to use the `top-bar` macro in `example-quest.yml`: ``` yaml tasks: - ... + # ... display: - ... + # ... lore-normal: - "<$m top-bar $>" - "..." - ... + # ... ``` {: .caution } diff --git a/docs/configuration/gui-configuration.md b/docs/configuration/gui-configuration.md index 6a40629a..5b5b5ed0 100644 --- a/docs/configuration/gui-configuration.md +++ b/docs/configuration/gui-configuration.md @@ -6,13 +6,13 @@ nav_order: 6 # GUI configuration -*See also [Custom GUI items](Custom_GUI_items "wikilink") and [Defining -items](Defining_items "wikilink").* +*See also [Custom GUI items](custom-gui-items) and [Defining +items](defining-items).* 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"). +described in [defining items](defining-items). ## Back button @@ -23,7 +23,7 @@ The back button displayed within sub menus. ``` yaml gui: - ... + # ... back-button: name: "&cReturn" lore: @@ -40,7 +40,7 @@ The previous page button displayed on paiginated menus. ``` yaml gui: - ... + # ... page-prev: name: "&7Previous Page" lore: @@ -60,7 +60,7 @@ The next page button displayed on paiginated menus. ``` yaml gui: - ... + # ... page-next: name: "&7Next Page" lore: @@ -80,7 +80,7 @@ item will automatically update on the page number. ``` yaml gui: - ... + # ... page-desc: name: "&7Page &c{page}" lore: @@ -96,11 +96,11 @@ The `{page}` variable represents the page number for the current page. *`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. +[requirements](creating-a-quest#requirements) are not met. ``` yaml gui: - ... + # ... quest-locked-display: name: "&c&lQuest Locked" lore: @@ -113,7 +113,7 @@ gui: ``` The `{quest}` variable represents the quest [display -name](Creating_a_quest#name "wikilink"), with its formatting stripped. +name](creating-a-quest#name), with its formatting stripped. The `{questid}` variable represents the quest ID. @@ -121,7 +121,7 @@ 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.md#GUI-truncate-requirements "wikilink") +requirements](basic-options#gui-truncate-requirements) ## Quest permission display @@ -133,7 +133,7 @@ permission to start. ``` yaml gui: - ... + # ... quest-permission-display: name: "&6&lNo Permission" lore: @@ -143,7 +143,7 @@ gui: ``` The `{quest}` variable represents the quest [display -name](Creating_a_quest#name "wikilink"), with its formatting stripped. +name](creating-a-quest#name), with its formatting stripped. The `{questid}` variable represents the quest ID. @@ -157,7 +157,7 @@ has completed, but are on cooldown. ``` yaml gui: - ... + # ... quest-cooldown-display: name: "&e&lQuest On Cooldown" lore: @@ -168,7 +168,7 @@ gui: ``` The `{quest}` variable represents the quest [display -name](Creating_a_quest#name "wikilink"), with its formatting stripped. +name](creating-a-quest#name), with its formatting stripped. The `{questid}` variable represents the quest ID. @@ -185,7 +185,7 @@ repeatable. ``` yaml gui: - ... + # ... quest-completed-display: name: "&a&lQuest Complete" lore: @@ -196,7 +196,7 @@ gui: ``` The `{quest}` variable represents the quest [display -name](Creating_a_quest#name "wikilink"), with its formatting stripped. +name](creating-a-quest#name), with its formatting stripped. The `{questid}` variable represents the quest ID. @@ -210,7 +210,7 @@ has not started any quests. ``` yaml gui: - ... + # ... no-started-quests: name: "&c&lNo Started Quests" lore: @@ -227,7 +227,7 @@ Confirmation item in the quest cancel menu. ``` yaml gui: - ... + # ... quest-cancel-yes: name: "&a&lConfirm Cancel" lore: @@ -246,7 +246,7 @@ Cancellation item in the quest cancel menu. ``` yaml gui: - ... + # ... quest-cancel-no: name: "&c&lAbort Cancel" lore: @@ -263,7 +263,7 @@ Background item in the quest cancel menu. ``` yaml gui: - ... + # ... quest-cancel-background: type: "GRAY_STAINED_GLASS_PANE" ``` diff --git a/docs/configuration/storage-providers.md b/docs/configuration/storage-providers.md index f8d68886..8aad7a55 100644 --- a/docs/configuration/storage-providers.md +++ b/docs/configuration/storage-providers.md @@ -37,7 +37,7 @@ Quests, and is a type of 'flatfile' storage. ``` yaml options: - ... + # ... storage: provider: "yaml" ``` @@ -58,7 +58,7 @@ consistency issues. > server loading player data before the old server has saved it. > > Quests offers a workaround, which is to [delay the loading of player -> data](#delay-loading "wikilink"). You may also want to +> data](#delay-loading). You may also want to > consider forcing players to switch servers through a hub server, or > decreasing the autosave period. In either case, the race condition still > exists; there is not an easy way to coordinate the loading/saving due to @@ -73,7 +73,7 @@ player data. ``` yaml options: - ... + # ... storage: provider: "mysql" ``` @@ -112,7 +112,7 @@ README](https://github.com/brettwooldridge/HikariCP). ### Delay loading Quests offers a workaround to the [race -condition](Storage_providers#Network "wikilink"), which is to delay the +condition](#network), which is to delay the loading of player data in hopes that the server before has enough time to save the data. @@ -120,12 +120,12 @@ You can enable this in your config here: ``` yaml options: - ... + # ... storage: provider: "mysql" synchronisation: delay-loading: 0 # (ticks - change to any value above 0) - ... + # ... ``` A value of 50 (2.5 seconds) should be enough for most servers, however |