From 7a2a45691068db51ba4e7dc851f44a17f545f0ae Mon Sep 17 00:00:00 2001 From: LMBishop <13875753+LMBishop@users.noreply.github.com> Date: Thu, 6 Jul 2023 13:57:32 +0100 Subject: Fix wiki links --- docs/Common-Configuration-Issues.md | 13 --- docs/Default-configuration.md | 1 - docs/Task-configuration-layout.md | 3 - docs/_Footer.md | 3 - docs/_Sidebar.md | 87 ----------------- docs/_Templates.md | 29 ------ docs/_config.yml | 19 +++- docs/_includes/incomplete.md | 3 + docs/commands-and-permissions.md | 2 +- docs/configuration/basic-options.md | 94 +++++++++---------- docs/configuration/colour-codes.md | 56 +++++------ docs/configuration/configuration-problems.md | 4 +- docs/configuration/creating-a-quest.md | 56 +++++------ docs/configuration/custom-gui-items.md | 4 +- docs/configuration/defining-items.md | 51 +++++----- docs/configuration/global-configurations.md | 10 +- docs/configuration/gui-configuration.md | 42 ++++----- docs/configuration/storage-providers.md | 12 +-- docs/contributing-to-the-wiki.md | 53 +++++------ docs/developer/api.md | 3 +- docs/developer/new-task-type.md | 4 +- docs/download.md | 8 +- docs/getting-started.md | 5 +- docs/guides/quest-progress-in-scoreboard.md | 6 +- docs/index.md | 102 ++++++++------------ docs/task-type/askyblock_level-(task-type).md | 31 ------- docs/task-type/bentobox_level-(task-type).md | 31 ------- docs/task-type/blockbreak-(task-type).md | 71 -------------- docs/task-type/blockplace-(task-type).md | 65 ------------- docs/task-type/breeding-(task-type).md | 31 ------- docs/task-type/brewing-(task-type).md | 31 ------- docs/task-type/bucketempty-(task-type).md | 33 ------- docs/task-type/bucketfill-(task-type).md | 33 ------- docs/task-type/citizens_deliver-(task-type).md | 80 ---------------- docs/task-type/citizens_interact-(task-type).md | 36 ------- docs/task-type/command-(task-type).md | 36 ------- docs/task-type/consume-(task-type).md | 64 ------------- docs/task-type/crafting-(task-type).md | 63 ------------- docs/task-type/dealdamage-(task-type).md | 31 ------- docs/task-type/distancefrom-(task-type).md | 36 ------- docs/task-type/enchanting-(task-type).md | 57 ------------ docs/task-type/essentials_balance-(task-type).md | 31 ------- docs/task-type/essentials_moneyearn-(task-type).md | 31 ------- docs/task-type/expearn-(task-type).md | 31 ------- docs/task-type/fabledskyblock_level-(task-type).md | 31 ------- docs/task-type/farming-(task-type).md | 66 ------------- docs/task-type/fishing-(task-type).md | 60 ------------ docs/task-type/index.md | 7 -- docs/task-type/inventory-(task-type).md | 74 --------------- .../task-type/iridiumskyblock_value-(task-type).md | 31 ------- docs/task-type/milking-(task-type).md | 31 ------- docs/task-type/mobkilling-(task-type).md | 103 --------------------- docs/task-type/mythicmobs_killing-(task-type).md | 40 -------- docs/task-type/permission-(task-type).md | 30 ------ .../placeholderapi_evaluate-(task-type).md | 49 ---------- docs/task-type/playerkilling-(task-type).md | 32 ------- docs/task-type/playtime-(task-type).md | 33 ------- docs/task-type/position-(task-type).md | 36 ------- docs/task-type/shearing-(task-type).md | 32 ------- docs/task-type/shopguiplus_buy-(task-type).md | 39 -------- docs/task-type/shopguiplus_sell-(task-type).md | 39 -------- docs/task-type/smelting-(task-type).md | 76 --------------- .../superiorskyblock_level-(task-type).md | 31 ------- .../superiorskyblock_worth-(task-type).md | 31 ------- docs/task-type/taming-(task-type).md | 31 ------- docs/task-type/uskyblock_level-(task-type).md | 31 ------- docs/task-type/votingplugin_vote-(task-type).md | 31 ------- docs/task-type/walking-(task-type).md | 43 --------- docs/task-types/askyblock_level-(task-type).md | 31 +++++++ docs/task-types/bentobox_level-(task-type).md | 31 +++++++ docs/task-types/blockbreak-(task-type).md | 71 ++++++++++++++ docs/task-types/blockplace-(task-type).md | 65 +++++++++++++ docs/task-types/breeding-(task-type).md | 31 +++++++ docs/task-types/brewing-(task-type).md | 31 +++++++ docs/task-types/bucketempty-(task-type).md | 33 +++++++ docs/task-types/bucketfill-(task-type).md | 33 +++++++ docs/task-types/citizens_deliver-(task-type).md | 80 ++++++++++++++++ docs/task-types/citizens_interact-(task-type).md | 36 +++++++ docs/task-types/command-(task-type).md | 36 +++++++ docs/task-types/consume-(task-type).md | 64 +++++++++++++ docs/task-types/crafting-(task-type).md | 63 +++++++++++++ docs/task-types/dealdamage-(task-type).md | 31 +++++++ docs/task-types/distancefrom-(task-type).md | 36 +++++++ docs/task-types/enchanting-(task-type).md | 57 ++++++++++++ docs/task-types/essentials_balance-(task-type).md | 31 +++++++ .../task-types/essentials_moneyearn-(task-type).md | 31 +++++++ docs/task-types/expearn-(task-type).md | 31 +++++++ .../task-types/fabledskyblock_level-(task-type).md | 31 +++++++ docs/task-types/farming-(task-type).md | 66 +++++++++++++ docs/task-types/fishing-(task-type).md | 60 ++++++++++++ docs/task-types/index.md | 7 ++ docs/task-types/inventory-(task-type).md | 74 +++++++++++++++ .../iridiumskyblock_value-(task-type).md | 31 +++++++ docs/task-types/milking-(task-type).md | 31 +++++++ docs/task-types/mobkilling-(task-type).md | 103 +++++++++++++++++++++ docs/task-types/mythicmobs_killing-(task-type).md | 40 ++++++++ docs/task-types/permission-(task-type).md | 30 ++++++ .../placeholderapi_evaluate-(task-type).md | 49 ++++++++++ docs/task-types/playerkilling-(task-type).md | 32 +++++++ docs/task-types/playtime-(task-type).md | 33 +++++++ docs/task-types/position-(task-type).md | 36 +++++++ docs/task-types/shearing-(task-type).md | 32 +++++++ docs/task-types/shopguiplus_buy-(task-type).md | 39 ++++++++ docs/task-types/shopguiplus_sell-(task-type).md | 39 ++++++++ docs/task-types/smelting-(task-type).md | 76 +++++++++++++++ .../superiorskyblock_level-(task-type).md | 31 +++++++ .../superiorskyblock_worth-(task-type).md | 31 +++++++ docs/task-types/taming-(task-type).md | 31 +++++++ docs/task-types/uskyblock_level-(task-type).md | 31 +++++++ docs/task-types/votingplugin_vote-(task-type).md | 31 +++++++ docs/task-types/walking-(task-type).md | 43 +++++++++ docs/tools/data-migration-tool.md | 2 +- 112 files changed, 2089 insertions(+), 2241 deletions(-) delete mode 100644 docs/Common-Configuration-Issues.md delete mode 100644 docs/Default-configuration.md delete mode 100644 docs/Task-configuration-layout.md delete mode 100644 docs/_Footer.md delete mode 100644 docs/_Sidebar.md delete mode 100644 docs/_Templates.md create mode 100644 docs/_includes/incomplete.md delete mode 100644 docs/task-type/askyblock_level-(task-type).md delete mode 100644 docs/task-type/bentobox_level-(task-type).md delete mode 100644 docs/task-type/blockbreak-(task-type).md delete mode 100644 docs/task-type/blockplace-(task-type).md delete mode 100644 docs/task-type/breeding-(task-type).md delete mode 100644 docs/task-type/brewing-(task-type).md delete mode 100644 docs/task-type/bucketempty-(task-type).md delete mode 100644 docs/task-type/bucketfill-(task-type).md delete mode 100644 docs/task-type/citizens_deliver-(task-type).md delete mode 100644 docs/task-type/citizens_interact-(task-type).md delete mode 100644 docs/task-type/command-(task-type).md delete mode 100644 docs/task-type/consume-(task-type).md delete mode 100644 docs/task-type/crafting-(task-type).md delete mode 100644 docs/task-type/dealdamage-(task-type).md delete mode 100644 docs/task-type/distancefrom-(task-type).md delete mode 100644 docs/task-type/enchanting-(task-type).md delete mode 100644 docs/task-type/essentials_balance-(task-type).md delete mode 100644 docs/task-type/essentials_moneyearn-(task-type).md delete mode 100644 docs/task-type/expearn-(task-type).md delete mode 100644 docs/task-type/fabledskyblock_level-(task-type).md delete mode 100644 docs/task-type/farming-(task-type).md delete mode 100644 docs/task-type/fishing-(task-type).md delete mode 100644 docs/task-type/index.md delete mode 100644 docs/task-type/inventory-(task-type).md delete mode 100644 docs/task-type/iridiumskyblock_value-(task-type).md delete mode 100644 docs/task-type/milking-(task-type).md delete mode 100644 docs/task-type/mobkilling-(task-type).md delete mode 100644 docs/task-type/mythicmobs_killing-(task-type).md delete mode 100644 docs/task-type/permission-(task-type).md delete mode 100644 docs/task-type/placeholderapi_evaluate-(task-type).md delete mode 100644 docs/task-type/playerkilling-(task-type).md delete mode 100644 docs/task-type/playtime-(task-type).md delete mode 100644 docs/task-type/position-(task-type).md delete mode 100644 docs/task-type/shearing-(task-type).md delete mode 100644 docs/task-type/shopguiplus_buy-(task-type).md delete mode 100644 docs/task-type/shopguiplus_sell-(task-type).md delete mode 100644 docs/task-type/smelting-(task-type).md delete mode 100644 docs/task-type/superiorskyblock_level-(task-type).md delete mode 100644 docs/task-type/superiorskyblock_worth-(task-type).md delete mode 100644 docs/task-type/taming-(task-type).md delete mode 100644 docs/task-type/uskyblock_level-(task-type).md delete mode 100644 docs/task-type/votingplugin_vote-(task-type).md delete mode 100644 docs/task-type/walking-(task-type).md create mode 100644 docs/task-types/askyblock_level-(task-type).md create mode 100644 docs/task-types/bentobox_level-(task-type).md create mode 100644 docs/task-types/blockbreak-(task-type).md create mode 100644 docs/task-types/blockplace-(task-type).md create mode 100644 docs/task-types/breeding-(task-type).md create mode 100644 docs/task-types/brewing-(task-type).md create mode 100644 docs/task-types/bucketempty-(task-type).md create mode 100644 docs/task-types/bucketfill-(task-type).md create mode 100644 docs/task-types/citizens_deliver-(task-type).md create mode 100644 docs/task-types/citizens_interact-(task-type).md create mode 100644 docs/task-types/command-(task-type).md create mode 100644 docs/task-types/consume-(task-type).md create mode 100644 docs/task-types/crafting-(task-type).md create mode 100644 docs/task-types/dealdamage-(task-type).md create mode 100644 docs/task-types/distancefrom-(task-type).md create mode 100644 docs/task-types/enchanting-(task-type).md create mode 100644 docs/task-types/essentials_balance-(task-type).md create mode 100644 docs/task-types/essentials_moneyearn-(task-type).md create mode 100644 docs/task-types/expearn-(task-type).md create mode 100644 docs/task-types/fabledskyblock_level-(task-type).md create mode 100644 docs/task-types/farming-(task-type).md create mode 100644 docs/task-types/fishing-(task-type).md create mode 100644 docs/task-types/index.md create mode 100644 docs/task-types/inventory-(task-type).md create mode 100644 docs/task-types/iridiumskyblock_value-(task-type).md create mode 100644 docs/task-types/milking-(task-type).md create mode 100644 docs/task-types/mobkilling-(task-type).md create mode 100644 docs/task-types/mythicmobs_killing-(task-type).md create mode 100644 docs/task-types/permission-(task-type).md create mode 100644 docs/task-types/placeholderapi_evaluate-(task-type).md create mode 100644 docs/task-types/playerkilling-(task-type).md create mode 100644 docs/task-types/playtime-(task-type).md create mode 100644 docs/task-types/position-(task-type).md create mode 100644 docs/task-types/shearing-(task-type).md create mode 100644 docs/task-types/shopguiplus_buy-(task-type).md create mode 100644 docs/task-types/shopguiplus_sell-(task-type).md create mode 100644 docs/task-types/smelting-(task-type).md create mode 100644 docs/task-types/superiorskyblock_level-(task-type).md create mode 100644 docs/task-types/superiorskyblock_worth-(task-type).md create mode 100644 docs/task-types/taming-(task-type).md create mode 100644 docs/task-types/uskyblock_level-(task-type).md create mode 100644 docs/task-types/votingplugin_vote-(task-type).md create mode 100644 docs/task-types/walking-(task-type).md diff --git a/docs/Common-Configuration-Issues.md b/docs/Common-Configuration-Issues.md deleted file mode 100644 index 515c4c5c..00000000 --- a/docs/Common-Configuration-Issues.md +++ /dev/null @@ -1,13 +0,0 @@ -*** - -### ๐Ÿ—‘๏ธ ***This page is subject to removal*** -*This page has been superseded, is unmaintained, or is not required. The information contained here may be inaccurate or incomplete.* - -*** - -# Common Configuration Issues - -### My items are showing up as stone blocks! -Make sure you are using the correct item namesfor your version. **Quests is pre-configured with the names for 1.13+ items - you MUST change them for 1.8!**. - -//todo finish me \ No newline at end of file diff --git a/docs/Default-configuration.md b/docs/Default-configuration.md deleted file mode 100644 index bb04edc8..00000000 --- a/docs/Default-configuration.md +++ /dev/null @@ -1 +0,0 @@ -Click [here](https://github.com/LMBishop/Quests/tree/master/bukkit/src/main/resources/resources/bukkit) \ No newline at end of file diff --git a/docs/Task-configuration-layout.md b/docs/Task-configuration-layout.md deleted file mode 100644 index 6a541dd7..00000000 --- a/docs/Task-configuration-layout.md +++ /dev/null @@ -1,3 +0,0 @@ -### ๐Ÿ”ƒ This information has moved - -Each task type now has its own individual page. Please see the sidebar or [this page](https://github.com/LMBishop/Quests/wiki/Task-types) to get to them. diff --git a/docs/_Footer.md b/docs/_Footer.md deleted file mode 100644 index cfdd9fd8..00000000 --- a/docs/_Footer.md +++ /dev/null @@ -1,3 +0,0 @@ -*This wiki serves as a manual for Quests, however there is no guarantee that the information is up-to-date or complete. As per the license, this software provides absolutely no warranty, nor are the maintainers liable for any damages. Please see the license text for more information.* - -[๐Ÿ  Home page](https://github.com/LMBishop/Quests/wiki/) ~ [๐Ÿ’ป Source code](https://github.com/LMBishop/Quests/) ~ [๐Ÿค Contributing to the wiki](https://github.com/LMBishop/Quests/wiki/Contributing-to-the-wiki) ~ [๐Ÿ“œ Full license text](https://github.com/LMBishop/Quests/blob/master/LICENSE.txt) \ No newline at end of file diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md deleted file mode 100644 index fc25c8c6..00000000 --- a/docs/_Sidebar.md +++ /dev/null @@ -1,87 +0,0 @@ -

-
-

- -## [Home / FAQs](https://github.com/LMBishop/Quests/wiki) - -[Getting started](getting-started) - -[Downloading](download) - -[Tips](tips) - -[Commands and permissions](commands-and-permissions) -### **Configuration** -* [Basic options](configuration/basic-options.md) -* [Creating a quest](configuration/creating-a-quest.md) -* [Creating a category](configuration/creating-a-category.md) -* [Global configurations](Global-Configurations) -* [GUI configuration](configuration/gui-configuration.md) -* [Custom GUI items](configuration/custom-gui-items.md) -* [Configuration problems](configuration/configuration-problems.md) -* [Storage providers](configuration/storage-providers.md) -* [Defining items](configuration/defining-items.md) -* [Colour (color) codes](configuration/colour-codes.md) -* [Default configuration](Default-configuration) - -### **Task Types** - -* [Task types](Task-types) - * [blockplace](blockplace-(task-type)) - * [blockbreak](blockbreak-(task-type)) - * [breeding](breeding-(task-type)) - * [brewing](brewing-(task-type)) - * [bucketempty](bucketempty-(task-type)) - * [bucketfill](bucketfill-(task-type)) - * [command](command-(task-type)) - * [consume](consume-(task-type)) - * [crafting](crafting-(task-type)) - * [dealdamage](dealdamage-(task-type)) - * [distancefrom](distancefrom-(task-type)) - * [enchanting](enchanting-(task-type)) - * [expearn](expearn-(task-type)) - * [farming](farming-(task-type)) - * [fishing](fishing-(task-type)) - * [inventory](inventory-(task-type)) - * [milking](milking-(task-type)) - * [mobkilling](mobkilling-(task-type)) - * [permission](permission-(task-type)) - * [playerkilling](playerkilling-(task-type)) - * [playtime](playtime-(task-type)) - * [position](position-(task-type)) - * [shearing](shearing-(task-type)) - * [taming](taming-(task-type)) - * [walking](walking-(task-type)) - * [smelting](smelting-(task-type)) - * [askyblock_level](askyblock_level-(task-type)) - * [bentobox_level](bentobox_level-(task-type)) - * [citizens_deliver](citizens_deliver-(task-type)) - * [citizens_interact](citizens_interact-(task-type)) - * [essentials_balance](essentials_balance-(task-type)) - * [essentials_moneyearn](essentials_moneyearn-(task-type)) - * [fabledskyblock_level](fabledskyblock_level-(task-type)) - * [iridiumskyblock_value](iridiumskyblock_value-(task-type)) - * [mythicmobs_killing](mythicmobs_killing-(task-type)) - * [placeholderapi_evaluate](placeholderapi_evaluate-(task-type)) - * [shopguiplus_buy](shopguiplus_buy-(task-type)) - * [shopguiplus_sell](shopguiplus_sell-(task-type)) - * [superiorskyblock_level](superiorskyblock_level-(task-type)) - * [superiorskyblock_worth](superiorskyblock_worth-(task-type)) - * [votingplugin_vote](votingplugin_vote-(task-type)) - * [uskyblock_level](uskyblock_level-(task-type)) - -### **API** - -* [API](developer/api.md) -* [New task type](developer/new-task-type.md) - -### **Guides** - -* [Quest progress in scoreboard](guides/quest-progress-in-scoreboard.md) - -### **Other** - -* [PlaceholderAPI](tools/placeholderapi.md) -* [Quest debugger](tools/quest-debugger.md) -* [Data migration tool](tools/data-migration-tool.md) -* [Contributing to the wiki](contributing-to-the-wiki) \ No newline at end of file diff --git a/docs/_Templates.md b/docs/_Templates.md deleted file mode 100644 index 01781df3..00000000 --- a/docs/_Templates.md +++ /dev/null @@ -1,29 +0,0 @@ -This page contains wikicode templates for use through the -wiki. GitHub does not support page transclusion so instead they should -be simply copied from here. - -## Dev build - - -**โš™๏ธ This section describes a feature currently only available in a -[development build](https://github.com/LMBishop/Quests/actions) of -quests.** - -## Under construction - ------------------------------------------------------------------------- - -### ๐Ÿ”จ **This page is under construction** - -*The information contained here may be inaccurate or incomplete. You can -help by [contributing information to the -wiki](https://github.com/LMBishop/Quests/wiki/Contributing-to-the-wiki).* - ------------------------------------------------------------------------- - -## Removed option - - -โ›”๏ธ **This option has been removed in version and this wiki entry is -subject to removal.** *Please see [{{{other}}}]({{{other}}} "wikilink") -instead.* diff --git a/docs/_config.yml b/docs/_config.yml index f41d5a4e..88b190a2 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -2,7 +2,9 @@ title: Quests description: Documentation for the Quests plugin theme: just-the-docs -url: https://lmbishop.github.io +url: "https://quests.leonardobishop.com" +baseurl: "" +repository: LMBishop/Quests callouts_level: quiet callouts: @@ -27,6 +29,21 @@ callouts: title: Warning color: red +back_to_top: true +back_to_top_text: "Back to top" + +gh_edit_link: true +gh_edit_link_text: "Edit this page on GitHub" +gh_edit_repository: "https://github.com/LMBishop/Quests" +gh_edit_branch: "master" +gh_edit_source: docs +gh_edit_view_mode: "tree" + +footer_content: > + This wiki serves as a manual for Quests however there is no guarantee that the information is up-to-date or complete. + As per the license, this software provides absolutely no warranty, nor are the maintainers liable for any damages. + Please see the license text for more information. + nav_external_links: - title: Quests on GitHub url: https://github.com/LMBishop/Quests diff --git a/docs/_includes/incomplete.md b/docs/_includes/incomplete.md new file mode 100644 index 00000000..9eddf0b7 --- /dev/null +++ b/docs/_includes/incomplete.md @@ -0,0 +1,3 @@ +{: .highlight } +**This page is under construction.** The information contained here may be inaccurate or incomplete. +You can help by [contributing information to the wiki](/contributing-to-the-wiki). diff --git a/docs/commands-and-permissions.md b/docs/commands-and-permissions.md index 8e10b845..351bffd7 100644 --- a/docs/commands-and-permissions.md +++ b/docs/commands-and-permissions.md @@ -45,7 +45,7 @@ also be viewed in-game by simply running `/quests`. - **/quests a/admin items give \ \ \[amount\]** - give a player a quest item. - **/quests a/admin debug** - view help for the [quest - debugger](quest_debugger "wikilink"). + debugger](tools/quest-debugger). - **/quests a/admin debug report** - generate a debug report. - **/quests a/admin debug quest \ \** - enable debug messages for a specific quest, or all of them. 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.`. ``` 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:": # apply to 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` | โœ… \* | \- | [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` | โœ… \* | \- | [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) | \*: The name must be defined for the display item of Quests. @@ -65,7 +65,7 @@ the end with a colon `:`. ``` 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 `, where `` is the desired name of the item. Your item will be saved to file items/\.yml, **with the type 'raw**'. - + + + ### 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: - ... + # ... # : 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 diff --git a/docs/contributing-to-the-wiki.md b/docs/contributing-to-the-wiki.md index 7a7a3c52..47f918bc 100644 --- a/docs/contributing-to-the-wiki.md +++ b/docs/contributing-to-the-wiki.md @@ -5,32 +5,23 @@ nav_order: 10 # Contributing to the wiki -{: .caution } -This information is out of date since the wiki migration. - If you spot any errors in the wiki, or want to add more information of -you own, then we would be happy to review potential changes. Due to the -restrictions of the GitHub wiki pages, it is not possible to open pull -requests to the wiki repository, instead changes will have to be -submitted through the [on the issue -tracker](https://github.com/LMBishop/Quests/issues/new?assignees=&labels=docs%2Cstatus%3A+needs+investigating&template=documentation.yml). +you own, then we would be happy to review changes. This documentation +is built directly from +[the `docs` directory on the `master` branch on GitHub](https://github.com/LMBishop/Quests/tree/master/docs), +using GitHub pages. ## Submitting edits -If you want to add information or edit the wiki, it would be beneficial -if you submitted the source code of the page within backticks to make it -easy to change the wiki. - -You can view the raw source code of a wiki page by adding `.mediawiki` -to the url, for example: -[`https://github.com/LMBishop/Quests/wiki/Storage-providers.mediawiki`](https://github.com/LMBishop/Quests/wiki/Storage-providers.mediawiki). -**Note that some pages are edited using Markdown, if `.mediawiki` does -not resolve then use `.md` instead. These pages do not use Wikitext but -will soon be converted to it.** - -Please make your edits to the page there, and submit the **full page** -in the issue tracker. Due to constraints of the GitHub wiki, there is no -way to easily submit revisions for review. +{: .new } +It is no longer necessary to submit edits through the issue tracker, +as documentation is now maintained within the repository itself. + +If you want to add information or edit the wiki, please fork this +repository and make your changes. + +If you need guidance, check out the [CONTRIBUTING.md](https://github.com/LMBishop/Quests/blob/master/CONTRIBUTING.md) +file in the main repository. ## Editing guidelines @@ -43,15 +34,15 @@ The Quests wiki loosely follows some conventions: with a short description at the top, they should never start with another heading. - British English should be used. -- Top-level headings should start at H2 (`## Heading` or - `== Heading ==`). H1 (`# Heading` or `= Heading =`) is never used as - this conflicts with the article title. The only exception to this is - on the home page, where the plugin name is displayed. -- Longer articles should have their contents listed at the top, with - wikilinks to each section of the page. -- Incomplete pages should have a warning at the top saying so. GitHub - wikis have no support for templates, or for transclusion, so you must - copy it manually from a different wiki page. +- Top-level headings should start at H2 (`## Heading`). H1 (`# Heading`) + is reserved for the article title itself. +- Longer articles should have a table of contents. +- Incomplete pages should have a warning at the top stating so. + You can transclude a pre-made banner by adding + `{% raw %}{% include incomplete.md %}{% endraw %}` to the page. +- Most files have an 80 character line limit, to assist with readability + in a split view, except links or source code / + configuration files. These conventions may or may not be wholly followed throughout the wiki, though it would be beneficial for new pages and new revisions to follow diff --git a/docs/developer/api.md b/docs/developer/api.md index 5bc91ff2..4ab49017 100644 --- a/docs/developer/api.md +++ b/docs/developer/api.md @@ -5,8 +5,7 @@ parent: Developer # API -{: .highlight } -**This page is under construction.** The information contained here may be inaccurate or incomplete. You can help by [contributing information to the wiki](https://github.com/LMBishop/Quests/wiki/Contributing-to-the-wiki). +{% include incomplete.md %} Quests provides an API for other people to use. **This API is experimental and may be subject to change.** For usages, it is best to take a look into the plugin itself. diff --git a/docs/developer/new-task-type.md b/docs/developer/new-task-type.md index cedc3711..3a054984 100644 --- a/docs/developer/new-task-type.md +++ b/docs/developer/new-task-type.md @@ -5,9 +5,7 @@ parent: Developer # New task type -{: .highlight } -**This page is under construction.** The information contained here may be inaccurate or incomplete. You can help by [contributing information to the wiki](https://github.com/LMBishop/Quests/wiki/Contributing-to-the-wiki). - +{% include incomplete.md %} The following information is for developers who are interested in integrating Quests into their own plugin. diff --git a/docs/download.md b/docs/download.md index 799cf804..c7bad947 100644 --- a/docs/download.md +++ b/docs/download.md @@ -1,6 +1,6 @@ --- title: Download -nav_order: 3 +nav_order: 2 --- # Download @@ -12,11 +12,11 @@ outdated versions. - [SpigotMC (preferred)](https://www.spigotmc.org/resources/quests-1-8-1-19-set-up-goals-for-players.23696/) +- [Hangar](https://hangar.papermc.io/LMBishop/Quests) - [Modrinth](https://modrinth.com/mod/quests) +- [GitHub](https://github.com/LMBishop/Quests/releases) - [Polymart](https://polymart.org/resource/quests.938) - [Songoda](https://songoda.com/marketplace/product/quests-quests.544) -- [GitHub](https://github.com/LMBishop/Quests/releases) -- [Hangar (testing)](https://hangar.benndorf.dev/LMBishop/Quests) Please note Hangar is still in active development and testing. It may be removed at any time. @@ -25,7 +25,7 @@ removed at any time. Some platforms may not be up-to-date yet. - + ## Development builds diff --git a/docs/getting-started.md b/docs/getting-started.md index c25ba9cc..2eafec15 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,11 +1,10 @@ --- title: Getting started -nav_order: 2 +nav_order: 3 --- # Getting started -{: .highlight } -**This page is under construction.** The information contained here may be inaccurate or incomplete. You can help by [contributing information to the wiki](https://github.com/LMBishop/Quests/wiki/Contributing-to-the-wiki). +{% include incomplete.md %} Welcome to Quests! This wiki should help you with creating your own custom quests on your server. diff --git a/docs/guides/quest-progress-in-scoreboard.md b/docs/guides/quest-progress-in-scoreboard.md index aa429dac..801e1088 100644 --- a/docs/guides/quest-progress-in-scoreboard.md +++ b/docs/guides/quest-progress-in-scoreboard.md @@ -44,7 +44,7 @@ These placeholders will be called using PlaceholderAPI using the AnimatedScoreboard plugin. For example, using the placeholder `%quests_q:example1_p:description%` with PlaceholderAPI will return `&7Break &f30 blocks &7of any type.`. These are known as [local quest -placeholders](../tools/placeholderapi.md#Quest_details "wikilink"). +placeholders](../tools/placeholderapi#quest-details). Our `description` placeholder provides a description of the quest. The \`progress\` placeholder will show the players progression with the @@ -62,7 +62,7 @@ To see the full quest (with comments), click {: .note } This guide assumes you have a basic understanding of the plugin -[](AnimatedScoreboard "wikilink"). +[AnimatedScoreboard](https://www.spigotmc.org/resources/animatedscoreboard.20848/). For our config with AnimatedScoreboard, we will create two seperate scoreboards: one with tracked quest information and one informing the @@ -185,4 +185,4 @@ quest placeholders for every quest. ## Further reading -- [Creating a quest](Creating_a_quest "wikilink") +- [Creating a quest](../configuration/creating-a-quest) diff --git a/docs/index.md b/docs/index.md index 84855e52..a64b6f84 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,123 +3,102 @@ title: Home nav_order: 1 ---
-
+
# Quests documentation Welcome to the Quests Wiki! Please use the sidebar for navigation around the wiki. +{: .fs-6 .fw-300 } -**๐ŸŒŸ New & Highlighted Articles** +--- -- [Tips](tips "wikilink") -- [Basic options](Basic_options "wikilink") -- [Creating a quest](Creating_a_quest "wikilink") -- [Creating a category](Creating_a_category "wikilink") -- [Custom GUI items](Custom_GUI_items "wikilink") -- [Task types](Task_types "wikilink") -- [PlaceholderAPI](tools/placeholderapi.md "wikilink") +{: .important } +The information on this wiki documents the most recent version of Quests, +and is built directly from the `docs` directory in the `master` branch on +GitHub. It may contain documentation for features not yet released. -Spot a mistake or ambiguous information? Please consider [contributing -to the wiki](contributing_to_the_wiki "wikilink"). +## New and highlighted articles -## FAQs +- [Tips](tips) +- [Basic options](configuration/basic-options) +- [Creating a quest](configuration/creating-a-quest) +- [Creating a category](configuration/creating-a-category) +- [Custom GUI items](configuration/custom-gui-items) +- [Task types](task-types) +- [PlaceholderAPI](tools/placeholderapi) -Q. What task types are there? +Spot a mistake or ambiguous information? Please consider [contributing +to the wiki](contributing-to-the-wiki). - +## FAQs +**Q. What task types are there?** -Many different [task types](task_types "wikilink") are provided. Follow +Many [task types](task-types) are provided with the plugin. Follow the links there to see how to format them. - - -Q. Can I use this plugin on a BungeeCord network/use MySQL? +Some task types require another plugin to activate. +**Q. Can I use this plugin on a BungeeCord network/use MySQL?** -Yes, refer to [storage providers](storage_providers "wikilink"). - - - -Q. Players are able to place blocks then break them to advance tasks! How do I stop this? +Yes, refer to [storage providers](configuration/storage-providers). +**Q. Players are able to place blocks then break them to advance tasks! How do I stop this?** -Take a look at the [Task configuration layout ยง -blockbreakcertain](Task_configuration_layout#blockbreakcertain "wikilink"). +Take a look at the options for +[blockbreakcertain](task-types/blockbreak-(task-type)). You can enable CoreProtect functionality to detect if a player has placed a block, or enable the `reverse-if-broken` flag which will subtract from task progress if a block is placed. -Q. How do I limit a quest to a certain world? - - - +**Q. How do I limit a quest to a certain world?** Most task types support world restrictions. Take a look at the task -configuration in [task configuration -layout](task_configuration_layout "wikilink") to see if your task does. - - - -Q. How do I organise quests in the GUI? +configuration in [task types](task-types) to see if your task does. +**Q. How do I organise quests in the GUI?** Quests can have a `sort-order`, which organises them within the GUI. You -can see it at [creating a quest](creating_a_quest "wikilink"). - - - +can see it at [creating a quest](configuration/creating-a-quest). If you want to add custom elements to a quest GUI, you can refer to -[custom GUI items](custom_GUI_items "wikilink"). - - - -Q. How to I only let specific players do specific quests? +[custom GUI items](configuration/custom-gui-items). +**Q. How to I only let specific players do specific quests?** Specific quests can have permissions enabled for them. Take a look at -[creating a quest](creating_a_quest "wikilink") for more information. +[creating a quest](configuration/creating-a-quest) for more information. Alternatively, entire categories can have permissions enabled. -Q. Does this plugin support PlaceholderAPI? +**Q. Does this plugin support PlaceholderAPI?** - - - -Yes, see [PlaceholderAPI](tools/placeholderapi.md "wikilink"). +Yes, see [PlaceholderAPI](tools/placeholderapi). -Q. How do I get quest progress on a scoreboard? +**Q. How do I get quest progress on a scoreboard?** - - - I have written a guide for this: [Quest progress in -scoreboard](Quest_progress_in_scoreboard "wikilink") +scoreboard](guides/quest-progress-in-scoreboard) -Q. I found a bug or have a feature request! Where do I report it? - - +**Q. I found a bug or have a feature request! Where do I report it?** - Great! Go to the [issue tracker](https://github.com/LMBishop/Quests/issues) to report bugs or create feature requests. Please avoid using Spigot's discussion pages or @@ -127,11 +106,8 @@ Discord for requests as I will most likely forget about it! -Q. I have a sizeable portion of money and I feel the need to donate it to you, where do I go? - - +**Q. I have a sizeable portion of money and I feel the need to donate it to you, where do I go?** - Consider giving your money to [Mind](https://www.mind.org.uk/donate); [Help for Heroes](https://www.helpforheroes.org.uk/donate-online/); [Cancer Research UK](https://www.cancerresearchuk.org/); or, any other diff --git a/docs/task-type/askyblock_level-(task-type).md b/docs/task-type/askyblock_level-(task-type).md deleted file mode 100644 index 823a79a6..00000000 --- a/docs/task-type/askyblock_level-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: askyblock_level -parent: Task types -nav_order: 27 ---- - -# askyblock_level (task type) - -Since v1.7.1 -{: .label .label-green } - -Plugin 'ASkyBlock' required -{: .label } - -Reach a certain ASkyBlock level. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|---------------------|---------|----------|---------|-------| -| `level` | The level to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island level 10: - -``` yaml -askyblock: - type: "askyblock_level" - level: 10 # island level needed -``` diff --git a/docs/task-type/bentobox_level-(task-type).md b/docs/task-type/bentobox_level-(task-type).md deleted file mode 100644 index 933ee21d..00000000 --- a/docs/task-type/bentobox_level-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: bentobox_level -parent: Task types -nav_order: 28 ---- - -# bentobox_level (task type) - -Since v2.12 -{: .label .label-green } - -Plugin 'BentoBox' required -{: .label } - -Reach a certain BentoBox level. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|---------------------|---------|----------|---------|-------| -| `level` | The level to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island level 10: - -``` yaml -bentobox: - type: "bentobox_level" - level: 10 # island level needed -``` diff --git a/docs/task-type/blockbreak-(task-type).md b/docs/task-type/blockbreak-(task-type).md deleted file mode 100644 index 66595b5a..00000000 --- a/docs/task-type/blockbreak-(task-type).md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: blockbreak -parent: Task types -nav_order: 1 ---- - -# blockbreak (task type) - -Since v1.0 -{: .label .label-green } - -Break a set amount of blocks. - -{: .note } -Since Quests v3.13, `blockbreakcertain` and `blockbreak` have been -merged into one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|--------------------------|------------------------------------------------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of blocks to break. | Integer | Yes | \- | \- | -| `block` | The specific blocks to break. | Material, or list of materials | No | \- | Not specifying this field will allow all blocks to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for block names. | -| `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | -| `reverse-if-placed` | Whether placing blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | -| `check-coreprotect` | Whether the plugin should query CoreProtect if a block has been recently placed. | Boolean | No | false | This requires the CoreProtect plugin. | -| `check-coreprotect-time` | How long ago (in seconds) the plugin should check with CoreProtect whether a block was placed. | Integer | No | \- | This requires the CoreProtect plugin. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Break 10 of any block: - -``` yaml -mining: - type: "blockbreak" - amount: 10 # amount of blocks to be broken - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Break 10 of stone: - -``` yaml -miningstone: - type: "blockbreakcertain" - amount: 10 # amount of blocks to be brkoen - block: STONE # name of block (can be id or minecraft name) - data: 1 # (OPTIONAL) data code - reverse-if-placed: false # (OPTIONAL) if true, blocks of same type placed will reverse progression (prevents silk-touch exploit) - check-coreprotect: false # (OPTIONAL) if true and CoreProtect is present, the plugin will check its logs for player placed blocks - check-coreprotect-time: 3600 # (OPTIONAL) time in seconds for the maximum logging period to check - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Break 10 of either stone or gold ore: - -``` yaml -miningmultiple: - type: "blockbreakcertain" - amount: 10 # amount of blocks to be placed - blocks: # name of blocks which will count towards progress - - STONE - - GOLD_ORE - reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) - check-coreprotect: false # (OPTIONAL) if true and CoreProtect is present, the plugin will check its logs for player placed blocks - check-coreprotect-time: 3600 # (OPTIONAL) time in seconds for the maximum logging period to check - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/blockplace-(task-type).md b/docs/task-type/blockplace-(task-type).md deleted file mode 100644 index e39538c8..00000000 --- a/docs/task-type/blockplace-(task-type).md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: blockplace -parent: Task types -nav_order: 2 ---- - -# blockplace (task type) - -Since v1.0 -{: .label .label-green} - -Place a set amount of blocks. - -{: .note } -Since Quests v3.13, `blockplacecertain` and `blockplace` have been -merged into one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------------------|-------------------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of blocks to place. | Integer | Yes | \- | \- | -| `block` | The specific blocks to place. | Material, or list of materials | No | \- | Not specifying this field will allow all blocks to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for block names. | -| `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | -| `reverse-if-broken` | Whether breaking blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Place 10 of any block: - -``` yaml -building: - type: "blockplace" - amount: 10 # amount of blocks to be placed - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Place 10 of stone: - -``` yaml -buildingstone: - type: "blockplace" - amount: 10 # amount of blocks to be placed - block: STONE # name of block (minecraft name) - data: 1 # (OPTIONAL) data code - reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Place 10 of either stone or gold ore: - -``` yaml -buildingmultiple: - type: "blockplace" - amount: 10 # amount of blocks to be placed - blocks: # name of blocks which will count towards progress - - STONE - - GOLD_ORE - reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/breeding-(task-type).md b/docs/task-type/breeding-(task-type).md deleted file mode 100644 index 66459f7d..00000000 --- a/docs/task-type/breeding-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: breeding -parent: Task types -nav_order: 3 ---- - -# breeding (task type) - -Since v2.2 -{: .label .label-green } - -Breed a certain amount of animals. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of animals to breed. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Breed 5 animals: - -``` yaml -breeding: - type: "breeding" - amount: 5 # amount of animals bred - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/brewing-(task-type).md b/docs/task-type/brewing-(task-type).md deleted file mode 100644 index 312e3dfb..00000000 --- a/docs/task-type/brewing-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: brewing -parent: Task types -nav_order: 4 ---- - -# brewing (task type) - -Since v2.0.13 -{: .label .label-green } - -Brew a set amount of potions. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of potions to brew. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Brew 8 potions: - -``` yaml -brewing: - type: "brewing" - amount: 10 # amount of potions brewed - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/bucketempty-(task-type).md b/docs/task-type/bucketempty-(task-type).md deleted file mode 100644 index 49806d17..00000000 --- a/docs/task-type/bucketempty-(task-type).md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucketempty -parent: Task types -nav_order: 5 ---- - -# bucketempty (task type) - -Since v3.9 -{: .label .label-green } - -Empty a bucket. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of buckets to empty. | Integer | Yes | \- | \- | -| `item` | The specific bucket to empty. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Empty 8 lava buckets: - -``` yaml -bucketempty : - type: "bucketempty" - bucket: LAVA_BUCKET # bucket to empty - amount: 8 # amount of times to empty - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/bucketfill-(task-type).md b/docs/task-type/bucketfill-(task-type).md deleted file mode 100644 index 3648d06e..00000000 --- a/docs/task-type/bucketfill-(task-type).md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: bucketfill -parent: Task types -nav_order: 6 ---- - -# bucketfill (task type) - -Since v3.9 -{: .label .label-green } - -Fill a bucket up. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of buckets to fill. | Integer | Yes | \- | \- | -| `item` | The specific bucket to fill. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Fill 8 lava buckets: - -``` yaml -bucketfill: - type: "bucketfill" - bucket: LAVA_BUCKET # bucket to fill - amount: 8 # amount of times to fill - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/citizens_deliver-(task-type).md b/docs/task-type/citizens_deliver-(task-type).md deleted file mode 100644 index 14f56f20..00000000 --- a/docs/task-type/citizens_deliver-(task-type).md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: citizens_deliver -parent: Task types -nav_order: 29 ---- - -# citizens_deliver (task type) - -Since v2.0.15 -{: .label .label-green } - -Plugin 'Citizens' required -{: .label } - -Deliver a set of items to a Citizens NPC. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to deliver. | Integer | Yes | \- | \- | -| `item` | The specific item to deliver. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | -| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | -| `remove-items-when-complete` | Whether the items should be taken from the player when complete. | Boolean | No | false | If `allow-partial-completion` is true, then this will also be set to true. | -| `allow-partial-completion` | Whether any number of items counts towards the task progress. | Boolean | No | true | Setting to true will force `remove-items-when-complete` to true as well. If a player obtains any matching item, it will be immediately taken away from them and added towards the quest progress. | -| `npc-name` | The name of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-id`. | -| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Deliver 8 of `BEEF` to an NPC named Gerald: - -``` yaml -citizensdeliver: - type: "citizens_deliver" - npc-name: "Gerald" # name of NPC - # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) - item: BEEF # name of item (can be id or minecraft name) - amount: 8 # amount of item needed - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Deliver 8 of a specific item to an NPC named Gerald: - -``` yaml -beef: - type: "citizens_deliver" - npc-name: "Gerald" # name of NPC - item: # SPECIFIC item with name and lore - name: "&cSpecial Beef" - type: "BEEF" - lore: - - "&7This is a special type of beef" - amount: 8 # amount of item needed - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - accept-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Deliver 8 of [quest item](Defining-items#quest-item "wikilink") -`special_beef` to an NPC named Gerald: - -``` yaml -beef: - type: "citizens_deliver" - npc-name: "Gerald" # name of NPC - # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) - item: # USING quest-item - quest-item: "special_beef" - amount: 8 # amount of item needed - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - accept-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/citizens_interact-(task-type).md b/docs/task-type/citizens_interact-(task-type).md deleted file mode 100644 index f25e9844..00000000 --- a/docs/task-type/citizens_interact-(task-type).md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: citizens_interact -parent: Task types -nav_order: 30 ---- - -# citizens_interact (task type) - -Since v2.0.15 -{: .label .label-green } - -Plugin 'Citizens' required -{: .label } - -Interact with a Citizens NPC. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|------------|-------------------------------------------------|---------------------|----------|---------|-------------------------------------| -| `npc-name` | The name of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-id`. | -| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Interact with an NPC named Gerald: - -``` yaml -citizensinteract: - type: "citizens_interact" - npc-name: "Gerald" # name of NPC - # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/command-(task-type).md b/docs/task-type/command-(task-type).md deleted file mode 100644 index 4e2d426f..00000000 --- a/docs/task-type/command-(task-type).md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: command -parent: Task types -nav_order: 7 ---- - -# command (task type) - -Since v2.12 -{: .label .label-green } - -Execute a specific command. - -This task may not work for commands not properly registered with the -server (e.g. commands made with plugins like DeluxeMenu). - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------------|------------------------------------------------------|---------------------|----------|---------|-------| -| `command` | The command to execute. | String | Yes | \- | \- | -| `ignore-case` | Whether the casing of the command should be ignored. | Boolean | No | false | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Ask for help: - -``` yaml -command: - type: "command" - command: "help" # command to execute - ignore-case: true # (OPTIONAL) ignore capitalisation - default: false - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/consume-(task-type).md b/docs/task-type/consume-(task-type).md deleted file mode 100644 index 4b748c89..00000000 --- a/docs/task-type/consume-(task-type).md +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: consume -parent: Task types -nav_order: 8 ---- - -# consume (task type) - -Since v3.9 -{: .label .label-green } - -Consume a specific item. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to consume. | Integer | Yes | \- | \- | -| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | -| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Consume 8 of `BEEF`: - -``` yaml -beef: - type: "consume" - item: BEEF # name of item (can be id or minecraft name) - amount: 8 # amount of item consumed - data: 0 # (OPTIONAL) data code - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Consume 8 of a specific item: - -``` yaml -beef: - type: "consume" - item: # SPECIFIC item with name and lore - name: "&cSpecial Beef" - type: "RAW_BEEF" - lore: - - "&7This is a special type of beef" - amount: 8 # amount of item consumed - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Consume 8 of [quest item](Defining-items#quest-items "wikilink") -`special_beef`: - -``` yaml -beef: - type: "consume" - item: # USING quest-item - quest-item: "special_beef" - amount: 8 # amount of item needed - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/crafting-(task-type).md b/docs/task-type/crafting-(task-type).md deleted file mode 100644 index 1622c502..00000000 --- a/docs/task-type/crafting-(task-type).md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: crafting -parent: Task types -nav_order: 9 ---- - -# crafting (task type) - -Since v3.0 -{: .label .label-green } - -Craft a set of items. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to craft. | Integer | Yes | \- | \- | -| `item` | The specific item to craft. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | -| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Craft 5 of `COMPASS`: - -``` yaml -compass: - type: "crafting" - item: COMPASS # name of item (can be id or minecraft name) - amount: 5 # amount of item needed - data: 0 # (OPTIONAL) data code - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Craft 5 of a specific item: - -``` yaml -compass: - type: "crafting" - item: # SPECIFIC item with name and lore - name: "&cSuper Compass" - type: "COMPASS" - lore: - - "&7This is special compass with a fancy name" - amount: 5 # amount of item needed - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Craft 5 of [quest item](Defining-items#quest-item "wikilink") -`super_compass`: - -``` yaml -compass: - type: "crafting" - item: # USING quest-item - quest-item: "super_compass" - amount: 5 # amount of item needed - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/dealdamage-(task-type).md b/docs/task-type/dealdamage-(task-type).md deleted file mode 100644 index 426f76e2..00000000 --- a/docs/task-type/dealdamage-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: dealdamage -parent: Task types -nav_order: 10 ---- - -# dealdamage (task type) - -Since v2.2 -{: .label .label-green } - -Deal a certain amount of damage. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------| -| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Deal 100 HP of damage: - -``` yaml -dealdamage: - type: "dealdamage" - amount: 100 # amount of damage inflicted (HP) - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/distancefrom-(task-type).md b/docs/task-type/distancefrom-(task-type).md deleted file mode 100644 index 5c0e8305..00000000 --- a/docs/task-type/distancefrom-(task-type).md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: distancefrom -parent: Task types -nav_order: 11 ---- - -# distancefrom (task type) - -Since v2.12 -{: .label .label-green } - -Travel away from a set of co-ordinates. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|------------|-----------------------------------------------------------------|---------|----------|---------|-------| -| `x` | The x co-ordinate. | Integer | Yes | \- | \- | -| `y` | The y co-ordinate. | Integer | Yes | \- | \- | -| `z` | The z co-ordinate. | Integer | Yes | \- | \- | -| `world` | The name of the world. | String | Yes | \- | \- | -| `distance` | The distance away from the co-ordinates the player must travel. | Integer | Yes | \- | \- | - -## Examples - -Travel at least 10 blocks away from (0, 0, 0) in world: - -``` yaml -distancefrom: - type: "distancefrom" - x: 0 # x position - y: 0 # y position - z: 0 # z position - world: world # name of world - distance: 10 # required distance from coordinates -``` diff --git a/docs/task-type/enchanting-(task-type).md b/docs/task-type/enchanting-(task-type).md deleted file mode 100644 index 1e2b6c80..00000000 --- a/docs/task-type/enchanting-(task-type).md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: enchanting -parent: Task types -nav_order: 12 ---- - -# enchanting (task type) - -Since v2.2 -{: .label .label-green } - -Enchant an item. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------------|-------------------------------------------------|--------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | -| `item` | The specific item to encahnt. | Material, or ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. If no item is specified, then any item can be enchanted. | -| `enchantment` | The specific enchantment(s) to apply. | Enchantment, or list of enchantments | No | \- | If no enchantments are specified, then any enchantment can be applied. | -| `min-level` | The minimum level of the enchantments. | Integer | No | \- | If no minimum level is specified, then any enchantment of any level can be applied. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Enchant 10 items: - -``` yaml -enchanting: - type: "enchanting" - amount: 10 # amount of items enchanted - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Enchant 10 items with Protection: - -``` yaml -beef: - type: "enchanting" - amount: 10 # amount of items - enchantment: PROTECTION_ENVIRONMENTAL # (OPTIONAL) enchantment to apply - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Enchant 10 items with Protection IV: - -``` yaml -beef: - type: "enchanting" - amount: 10 # amount of items - enchantment: PROTECTION_ENVIRONMENTAL # (OPTIONAL) enchantment to apply - min-level: 4 # (OPTIONAL) the minimum level of enchantment to apply - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/essentials_balance-(task-type).md b/docs/task-type/essentials_balance-(task-type).md deleted file mode 100644 index 6d246376..00000000 --- a/docs/task-type/essentials_balance-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: essentials_balance -parent: Task types -nav_order: 31 ---- - -# essentials_balance (task type) - -Since v2.12 -{: .label .label-green } - -Plugin 'Essentials' required -{: .label } - -Reach a certain balance. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|----------------------|---------|----------|---------|-------| -| `amount` | The amount to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach a balance of \$1000: - -``` yaml -essentialsbalance: - type: "essentials_balance" - amount: 1000 # amount of money to rach -``` diff --git a/docs/task-type/essentials_moneyearn-(task-type).md b/docs/task-type/essentials_moneyearn-(task-type).md deleted file mode 100644 index eba692fa..00000000 --- a/docs/task-type/essentials_moneyearn-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: essentials_moneyearn -parent: Task types -nav_order: 32 ---- - -# essentials_moneyearn (task type) - -Since v2.12 -{: .label .label-green } - -Plugin 'Essentials' required -{: .label } - -Earn a certain amount of money after starting quest. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|---------------------|---------|----------|---------|-------| -| `amount` | The amount to earn. | Integer | Yes | \- | \- | - -## Examples - -Earn \$1000: - -``` yaml -essentialsbalance: - type: "essentials_moneyearn" - amount: 1000 # amount of money to earn -``` diff --git a/docs/task-type/expearn-(task-type).md b/docs/task-type/expearn-(task-type).md deleted file mode 100644 index 86cbf5ca..00000000 --- a/docs/task-type/expearn-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: expearn -parent: Task types -nav_order: 13 ---- - -# expearn (task type) - -Since v2.2 -{: .label .label-green } - -Earn a set amount of exp after starting the quest. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The amount of experience to earn. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Earn 20 experience: - -``` yaml -expearn: - type: "expearn" - amount: 20 # amount of experience earned - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/fabledskyblock_level-(task-type).md b/docs/task-type/fabledskyblock_level-(task-type).md deleted file mode 100644 index eecf2dc0..00000000 --- a/docs/task-type/fabledskyblock_level-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: fabledskyblock_level -parent: Task types -nav_order: 33 ---- - -# fabledskyblock_level (task type) - -Since v3.5 -{: .label .label-green } - -Plugin 'FabledSkyblock' required -{: .label } - -Reach a certain FabledSkyblock level. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|---------------------|---------|----------|---------|-------| -| `level` | The level to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island level 10: - -``` yaml -fabledskyblock: - type: "fabledskyblock_level" - level: 10 # island level needed -``` diff --git a/docs/task-type/farming-(task-type).md b/docs/task-type/farming-(task-type).md deleted file mode 100644 index 57406c00..00000000 --- a/docs/task-type/farming-(task-type).md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: farming -parent: Task types -nav_order: 14 ---- - -# farming (task type) - -Since v3.5 -{: .label .label-green } - -Minecraft 1.13+ required -{: .label .label-purple } - -*For previous versions, use [blockbreak](blockbreak_(task_type) "wikilink").* - -Farm a set amount of crops. - -{: .note } -Since Quests v3.13, `farmingcertain` and `farming` have been merged into -one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|-------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of crops to farm. | Integer | Yes | \- | \- | -| `block` | The specific crop(s) to farm. | Material, or list of material | No | \- | Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. Note that some items are confusingly named, they may refer to the held item or block instead of the crop block. | -| `mode` | The mode to harvest crops. | String | No | \- | One of: `break`, `harvest`. A harvest is where a block drops an item (usually a crop) but does not change state. If this is not specified, both will be accepted. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Farm 10 crops: - -``` yaml -farming: - type: "farming" - amount: 10 # amount of blocks to be broken - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Farm 10 wheat: - -``` yaml -farming: - type: "farming" - amount: 10 # amount of blocks to be brkoen - block: WHEAT # name of block (can be id or minecraft name) - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Farm 10 wheat or beetroot: - -``` yaml -farmingmultiple: - type: "farming" - amount: 10 # amount of blocks to be placed - blocks: # name of blocks which will count towards progress - - WHEAT - - BEETROOT - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/fishing-(task-type).md b/docs/task-type/fishing-(task-type).md deleted file mode 100644 index 0143bbe4..00000000 --- a/docs/task-type/fishing-(task-type).md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: fishing -parent: Task types -nav_order: 15 ---- - -# fishing (task type) - -Since v2.0 -{: .label .label-green } - -Fish a set amount of items. - -{: .note } -Since Quests v3.13, `fishingcertain` and `fishing` have been merged into -one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|--------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------| -| `amount` | The number of fish to catch. | Integer | Yes | \- | \- | -| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Fish 10 of any item: - -``` yaml -fishing: - type: "fishing" - amount: 10 # amount of fish caught - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Fish 10 pufferfish: - -``` yaml -fishingcertain: - type: "fishingcertain" - item: PUFFERFISH # type of item caught - amount: 10 # amount of item caught - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Fish 10 of [quest item](Defining-items#Quest-items "wikilink") -`super_fish`: - -``` yaml -fishingcertain: - type: "fishingcertain" - item: # type of item caught - quest-item: "super_fish" - amount: 10 # amount of item caught - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/index.md b/docs/task-type/index.md deleted file mode 100644 index 4b0e657f..00000000 --- a/docs/task-type/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Task types -has_children: true -nav_order: 6 ---- - -# Task types \ No newline at end of file diff --git a/docs/task-type/inventory-(task-type).md b/docs/task-type/inventory-(task-type).md deleted file mode 100644 index 67354434..00000000 --- a/docs/task-type/inventory-(task-type).md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: inventory -parent: Task types -nav_order: 16 ---- - -# inventory (task type) - -Since v1.4 -{: .label .label-green } - - -Obtain a set of items. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | -| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | -| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | -| `remove-items-when-complete` | Whether the items should be taken from the player when complete. | Boolean | No | false | If `allow-partial-completion` is true, then this will also be set to true. | -| `allow-partial-completion` | Whether any number of items counts towards the task progress. | Boolean | No | true | Setting to true will force `remove-items-when-complete` to true as well. If a player obtains any matching item, it will be immediately taken away from them and added towards the quest progress. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Obtain 8 of `BEEF`: - -``` yaml -beef: - type: "inventory" - item: BEEF # name of item (can be id or minecraft name) - amount: 8 # amount of item needed - data: 0 # (OPTIONAL) data code - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Obtain 8 of a specific item: - -``` yaml -beef: - type: "inventory" - item: # SPECIFIC item with name and lore - name: "&cSpecial Beef" - type: "RAW_BEEF" - lore: - - "&7This is a special type of beef" - amount: 8 # amount of item needed - data: 0 # (OPTIONAL) data code - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Obtain 8 of [quest item](Defining-items#quest-item "wikilink") -`special_beef`: - -``` yaml -beef: - type: "inventory" - item: # USING quest-item - quest-item: "specialbeef" - amount: 8 # amount of item needed - data: 0 # (OPTIONAL) data code - remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false - allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/iridiumskyblock_value-(task-type).md b/docs/task-type/iridiumskyblock_value-(task-type).md deleted file mode 100644 index 40ca8a8c..00000000 --- a/docs/task-type/iridiumskyblock_value-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: iridiumskyblock_value -parent: Task types -nav_order: 34 ---- - -# iridiumskyblock_value (task type) - -Since v3.5 -{: .label .label-green } - -Plugin 'IridiumSkyblock' required - version 2.x only -{: .label } - -Reach a certain IridiumSkyblock value. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|--------------------|---------|----------|---------|-------| -| `value` | The valueto reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island value 10: - -``` yaml -iridiumskyblock: - type: "iridiumskyblock_value" - value: 10 # island level needed -``` diff --git a/docs/task-type/milking-(task-type).md b/docs/task-type/milking-(task-type).md deleted file mode 100644 index 75c2ed86..00000000 --- a/docs/task-type/milking-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: milking -parent: Task types -nav_order: 17 ---- - -# milking (task type) - -Since v2.0 -{: .label .label-green } - -Milk a set amount of cows. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of cows to milk. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Milk 10 cows: - -``` yaml -milking: - type: "milking" - amount: 10 # amount of cows milked - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/mobkilling-(task-type).md b/docs/task-type/mobkilling-(task-type).md deleted file mode 100644 index 8ad286a3..00000000 --- a/docs/task-type/mobkilling-(task-type).md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: mobkilling -parent: Task types -nav_order: 18 ---- - -# mobkilling (task type) - -Since v2.0 -{: .label .label-green } - -Kill a set amount of mobs. - -{: .note } -Since Quests v3.13, `mobkillingcertain` and `mobkilling` have been -merged into one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|-----------|--------------------------------------------------|----------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | -| `mob` | The specific mob(s) to kill. | Entity type, or list of entities | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | -| `name` | The specific name(s) of mobs to kill. | String, or list of strings | No | \- | Not specifying this field will allow mobs with any names to count towards the task. Ensure any colour codes in the name of the entity are specified, otherwise the match will not work. | -| `hostile` | Whether the mob must be hostile. | Boolean | No | \- | If specified and set to false, only non-hostile mobs will count. | -| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Kill 10 of any mob: - -``` yaml -mobkilling: - type: "mobkilling" - amount: 10 # amount of mobs to be killed - hostile: true # (OPTIONAL) whether or not the mob is hostile - default: both - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Kill 10 of a blaze named (red) "Inferno": - -``` yaml -mobkillingblaze: - type: "mobkilling" - amount: 10 # amount of mobs to be killed - mob: BLAZE # (OPTIONAL) type of mob - name: &cInferno # (OPTIONAL) this only allows blazes called "&cInferno" - default: any name - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Kill 10 of a blade named either (red) "Inferno" or (orange) "Furnace": - -``` yaml -mobkillingblazemultiple: - type: "mobkilling" - amount: 10 # amount of mobs to be killed - mob: BLAZE # (OPTIONAL) type of mob - names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name - - "&cInferno" - - "&6Furnace" - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Kill 10 of a blaze or creeper named either (red) "Inferno" or (orange) -"Furnace": - -``` yaml -mobkillingblazemultiple: - type: "mobkilling" - amount: 10 # amount of mobs to be killed - mob: # (OPTIONAL) types of mobs - - BLAZE - - CREEPER - names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name - - "&cInferno" - - "&6Furnace" - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Kill 10 of a blaze or creeper named either (red) "Inferno" or (orange) -"Furnace" with [quest item](Defining-items#Quest-items "wikilink") -"super_sword": - -``` yaml -mobkillingblazecreepermultiple: - type: "mobkilling" - amount: 10 # amount of mobs to be killed - mob: # (OPTIONAL) types of mobs - - BLAZE - - CREEPER - names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name - - "&cInferno" - - "&6Furnace" - item: # (OPTIONAL) specific item to kill with - quest-item: "super_sword" - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/mythicmobs_killing-(task-type).md b/docs/task-type/mythicmobs_killing-(task-type).md deleted file mode 100644 index 4862f66d..00000000 --- a/docs/task-type/mythicmobs_killing-(task-type).md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: mythicmobs_killing -parent: Task types -nav_order: 35 ---- - -# mythicmobs_killing (task type) - -Since v2.3 -{: .label .label-green } - -Plugin 'MythicMobs' required -{: .label } - -Kill a certain MythicMobs mob. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|-------------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | -| `name` | The MythicMob ID. | String | Yes | \- | \- | -| `level` | The level the mob must be at. | Integer | Yes | \- | \- | -| `min-level` | The minimum level the mob must be at. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Kill 1 mythic mob with the ID "SkeletalKnight": - -``` yaml -mythicmobs: - type: "mythicmobs_killing" - amount: 1 # amount of mobs to be killed - name: "SkeletalKnight" # internal name of mob (name in config - NOT display name) - level: 1 # (OPTIONAL) the exact level the mob must be for it to count - min-level: 1 # (OPTIONAL) the minimum level the mob must be for it to count - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/permission-(task-type).md b/docs/task-type/permission-(task-type).md deleted file mode 100644 index aa55c00a..00000000 --- a/docs/task-type/permission-(task-type).md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: permission -parent: Task types -nav_order: 19 ---- - -# permission (task type) - -Since v2.9.5 -{: .label .label-green } - -Test if a player has a permission. - -This task works by regularly polling a player at a certain interval. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|--------------|----------------------------------------|--------|----------|---------|-------| -| `permission` | The permission the player should have. | String | Yes | \- | \- | - -## Examples - -Check if player has permission `some.permission.name`: - -``` yaml -permission: - type: "permission" - permission: "some.permission.name" # permission required to be marked as complete -``` diff --git a/docs/task-type/placeholderapi_evaluate-(task-type).md b/docs/task-type/placeholderapi_evaluate-(task-type).md deleted file mode 100644 index 87079d7f..00000000 --- a/docs/task-type/placeholderapi_evaluate-(task-type).md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: placeholderapi_evaluate -parent: Task types -nav_order: 36 ---- - -# placeholderapi_evaluate (task type) - -Since v2.9.5 -{: .label .label-green } - -Plugin 'PlaceholderAPI' required -{: .label } - -Evaluate a certain PlaceholderAPI placeholder and compare it against a given condition. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------------|-----------------------------------------------------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `placeholder` | The placeholder to evaluate. | String | Yes | \- | \- | -| `evaluates` | The string the placeholder should evaluate to. | String | Yes | \- | \- | -| `operator` | The comparative operator to use for numeric placeholders. | String | No | \- | One of: `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL_TO`, `LESS_THAN_OR_EQUAL_TO`. The value in `evaluates` **must** be numeric. If this is not specified, then exact equality will be assumed. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Have a player name of "fatpigsarefat": - -``` yaml -papieval: - type: "placeholderapi_evaluate" - placeholder: "%player_name%" # placeholder string - evaluates: "fatpigsarefat" # what it should evaluate as to be marked as complete - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Be online when there are more than 20 empty slots on the server: - -``` yaml -papieval: - type: "placeholderapi_evaluate" - placeholder: "%player_empty_slots%" # placeholder string - evaluates: "20" # number to compare to - operator: "GREATER_THAN" # (OPTIONAL) numerical operator, "evaluates" MUST be an integer - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/playerkilling-(task-type).md b/docs/task-type/playerkilling-(task-type).md deleted file mode 100644 index 4aee13bf..00000000 --- a/docs/task-type/playerkilling-(task-type).md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: playerkilling -parent: Task types -nav_order: 20 ---- - -# playerkilling (task type) - -Since v2.0 -{: .label .label-green } - - -Kill a set amount of players. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of players to kill. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Kill 10 of any player: - -``` yaml -killplayers: - type: "playerkilling" - amount: 10 # amount of players to kill - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/playtime-(task-type).md b/docs/task-type/playtime-(task-type).md deleted file mode 100644 index 649b0db4..00000000 --- a/docs/task-type/playtime-(task-type).md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: playtime -parent: Task types -nav_order: 21 ---- - -# playtime (task type) - -Since v1.8 -{: .label .label-green } - -Play for a certain amount of time after starting the quest. - -{: .note } -Before Quests v2.0, this task was known as `TIMEPLAYED`. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|--------------|----------------------------------------|---------|----------|---------|----------------------| -| `minutes` | The number of minutes to play. | Integer | Yes | \- | \- | -| `ignore-afk` | Whether AFK players should be ignored. | Boolean | Yes | \- | Requires Essentials. | - -## Examples - -Play for 20 minutes: - -``` yaml -playtime: - type: "playtime" - minutes: 10 # amount of minutes played - ignore-afk: false # (OPTIONAL) ignore players marked as AFK by essentials -``` diff --git a/docs/task-type/position-(task-type).md b/docs/task-type/position-(task-type).md deleted file mode 100644 index bf990ca8..00000000 --- a/docs/task-type/position-(task-type).md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: position -parent: Task types -nav_order: 22 ---- - -# position (task type) - -Since v2.0.3 -{: .label .label-green } - -Reach a set of co-ordinates. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|--------------------|-----------------------------------------------------------|---------|----------|---------|----------------------------------------------------------------------| -| `x` | The x co-ordinate. | Integer | Yes | \- | \- | -| `y` | The y co-ordinate. | Integer | Yes | \- | \- | -| `z` | The z co-ordinate. | Integer | Yes | \- | \- | -| `world` | The name of the world. | String | Yes | \- | \- | -| `distance-padding` | The distance around the co-ordinate the player can reach. | Integer | No | \- | Having no padding means the player must reach the exact co-ordinate. | - -## Examples - -Travel to within 10 blocks of (0, 0, 0) in world: - -``` yaml -position: - type: "position" - x: 0 # x position - y: 0 # y position - z: 0 # z position - world: world # name of world - distance-padding: 10 # (OPTIONAL) padding zone in meters/blocks - this will allow within 10 blocks of 0, 0, 0 - default = 0 -``` diff --git a/docs/task-type/shearing-(task-type).md b/docs/task-type/shearing-(task-type).md deleted file mode 100644 index 5c81e1e7..00000000 --- a/docs/task-type/shearing-(task-type).md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: shearing -parent: Task types -nav_order: 23 ---- - -# shearing (task type) - -Since v2.0 -{: .label .label-green } - - -Shear a set amount of sheep. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of sheep to shear. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Shear 10 sheep: - -``` yaml -shearing: - type: "shearing" - amount: 10 # amount of sheep sheared - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/shopguiplus_buy-(task-type).md b/docs/task-type/shopguiplus_buy-(task-type).md deleted file mode 100644 index 85c03ae9..00000000 --- a/docs/task-type/shopguiplus_buy-(task-type).md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: shopguiplus_buy -parent: Task types -nav_order: 37 ---- - -# shopguiplus_buy (task type) - -Since v2.15 -{: .label .label-green } - -Plugin 'ShopGUI+' required -{: .label } - -Buy a certain number of items from a ShopGUI+ shop. - -{: .note } -Since Quests v3.13, `shopguiplus_buycertain` and `shopguiplus_buy` have -been merged into one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|-----------|-----------------------------|---------|----------|---------|-------| -| `amount` | The number of items to buy. | Integer | Yes | \- | \- | -| `shop-id` | The ID of the shop. | String | Yes | \- | \- | -| `item-id` | The ID of the item to buy. | String | Yes | \- | \- | - -## Examples - -Buy 1000 of item_id from shop_id: - -``` yaml -shopguiplusbuy: - type: "shopguiplus_buy" - shop-id: "shop_id" # shopgui+ id of the shop that contains the item. - item-id: "item_id" # shopgui+ id of item to sell - amount: 1000 # amount of thing to sell -``` diff --git a/docs/task-type/shopguiplus_sell-(task-type).md b/docs/task-type/shopguiplus_sell-(task-type).md deleted file mode 100644 index a1c94a10..00000000 --- a/docs/task-type/shopguiplus_sell-(task-type).md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: shopguiplus_sell -parent: Task types -nav_order: 38 ---- - -# shopguiplus_sell (task type) - -Since v2.15 -{: .label .label-green } - -Plugin 'ShopGUI+' required -{: .label } - -Sell a certain number of items to a ShopGUI+ shop. - -{: .note } -Since Quests v3.13, `shopguiplus_sellcertain` and `shopguiplus_sell` -have been merged into one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|-----------|------------------------------|---------|----------|---------|-------| -| `amount` | The number of items to sell. | Integer | Yes | \- | \- | -| `shop-id` | The ID of the shop. | String | Yes | \- | \- | -| `item-id` | The ID of the item to sell. | String | Yes | \- | \- | - -## Examples - -Sell 1000 of item_id to shop_id: - -``` yaml -shopguiplussell: - type: "shopguiplus_sell" - shop-id: "shop_id" # shopgui+ id of the shop that contains the item. - item-id: "item_id" # shopgui+ id of item to sell - amount: 1000 # amount of thing to sell -``` diff --git a/docs/task-type/smelting-(task-type).md b/docs/task-type/smelting-(task-type).md deleted file mode 100644 index 6a6f3f49..00000000 --- a/docs/task-type/smelting-(task-type).md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: smelting -parent: Task types -nav_order: 24 ---- - -# smelting (task type) - -Since v3.12 -{: .label .label-green } - -Cook a set amount of an item. - -{: .note } -Since Quests v3.13, `smeltingcertain` and `smelting` have been merged -into one. Both names can be used to refer to this task. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `amount` | The number of items to smelt. | Integer | Yes | \- | \- | -| `item` | The specific item to smelt. | Material, or ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. If this is not specified, any item will count. | -| `mode` | The specific mode of smelting. | String | No | \- | One of: `smoker`, `blast_furnace`, `furnace`. If this is not specified, any furnace will count. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Smelt 10 items: - -``` yaml -smelting: - type: "smelting" - amount: 10 # amount to smelt - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Cook 10 steak: - -``` yaml -smeltingcertain: - type: "smeltingcertain" - amount: 10 # amount to smelt - item: STEAK # type of item - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Cook 10 of a specific item: - -``` yaml -smeltingcertain: - type: "smeltingcertain" - amount: 10 # amount to smelt - item: # SPECIFIC item with name and lore - name: "&cSpecial Beef" - type: "RAW_BEEF" - lore: - - "&7This is a special type of beef" - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Cook 10 of [quest item](Defining-items#quest-item "wikilink") -`special_beef`: - -``` yaml -smeltingcertain: - type: "smeltingcertain" - amount: 10 # amount to smelt - item: # type of item - quest-item: "special_beef" - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/superiorskyblock_level-(task-type).md b/docs/task-type/superiorskyblock_level-(task-type).md deleted file mode 100644 index c23996b6..00000000 --- a/docs/task-type/superiorskyblock_level-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: superiorskyblock_level -parent: Task types -nav_order: 39 ---- - -# superiorskyblock_level (task type) - -Since v3.7 -{: .label .label-green } - -Plugin 'SuperiorSkyblock' required -{: .label } - -Reach a certain SuperiorSkyblock level. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|---------------------|---------|----------|---------|-------| -| `level` | The level to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island level 10: - -``` yaml -superiorskyblock: - type: "superiorskyblock_level" - level: 10 # island level needed -``` diff --git a/docs/task-type/superiorskyblock_worth-(task-type).md b/docs/task-type/superiorskyblock_worth-(task-type).md deleted file mode 100644 index a47d50fe..00000000 --- a/docs/task-type/superiorskyblock_worth-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: superiorskyblock_worth -parent: Task types -nav_order: 40 ---- - -# superiorskyblock_worth (task type) - -Since v3.7 -{: .label .label-green } - -Plugin 'SuperiorSkyblock' required -{: .label } - -Reach a certain SuperiorSkyblock worth. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|---------------------|---------|----------|---------|-------| -| `worth` | The worth to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island worth 100: - -``` yaml -superiorskyblock: - type: "superiorskyblock_worth" - level: 100 # island worth needed -``` diff --git a/docs/task-type/taming-(task-type).md b/docs/task-type/taming-(task-type).md deleted file mode 100644 index 1847bda4..00000000 --- a/docs/task-type/taming-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: taming -parent: Task types -nav_order: 25 ---- - -# taming (task type) - -Since v3.13 -{: .label .label-green } - -Tame a set amount of animals. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|-------------------------------------------------|---------------------|----------|---------|-------| -| `amount` | The number of animals to tame. | Integer | Yes | \- | \- | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Tame 10 animals: - -``` yaml -taming: - type: "taming" - amount: 10 # amount of mobs tamed - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-type/uskyblock_level-(task-type).md b/docs/task-type/uskyblock_level-(task-type).md deleted file mode 100644 index 729ca5c6..00000000 --- a/docs/task-type/uskyblock_level-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: uskyblock_level -parent: Task types -nav_order: 41 ---- - -# uskyblock_level (task type) - -Since v1.7.1 -{: .label .label-green } - -Plugin 'uSkyBlock' required -{: .label } - -Reach a certain uSkyBlock level. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|---------|---------------------|---------|----------|---------|-------| -| `level` | The level to reach. | Integer | Yes | \- | \- | - -## Examples - -Reach island level 10: - -``` yaml -askyblock: - type: "uskyblock_level" - level: 10 # island level needed -``` diff --git a/docs/task-type/votingplugin_vote-(task-type).md b/docs/task-type/votingplugin_vote-(task-type).md deleted file mode 100644 index 6a17abac..00000000 --- a/docs/task-type/votingplugin_vote-(task-type).md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: votingplugin_vote -parent: Task types -nav_order: 42 ---- - -# votingplugin_vote (task type) - -Since v3.7 -{: .label .label-green } - -Plugin 'VotingPlugin' required -{: .label } - -Vote a number of times using VotingPlugin. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|----------|----------------------|---------|----------|---------|-------| -| `amount` | The number of votes. | Integer | Yes | \- | \- | - -## Examples - -Vote 10 times: - -``` yaml -votingplugin: - type: "votingplugin_vote" - amount: 10 # number of times to vote -``` diff --git a/docs/task-type/walking-(task-type).md b/docs/task-type/walking-(task-type).md deleted file mode 100644 index 4c38fc27..00000000 --- a/docs/task-type/walking-(task-type).md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: walking -parent: Task types -nav_order: 26 ---- - -# walking (task type) - -Since v2.0 -{: .label .label-green } - -Walk a set distance. - -## Options - -| Key | Description | Type | Required | Default | Notes | -|------------|-------------------------------------------------|---------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `distance` | The distance in metres to walk. | Integer | Yes | \- | 1 metre is equivalent to 1 block. | -| `mode` | The specific mode to travel | String | No | \- | One of: `boat`, `horse`, `pig`, `minecart` `strider`, `sneaking`, `walking`, `running`, `swimming`, `flying`, `elytra`. Not specifying a mode will allow any of these modes to count. | -| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | - -## Examples - -Travel 1000 metres: - -``` yaml -walking: - type: "walking" - distance: 1000 # distance in blocks travelled - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` - -Travel 1000 metres by sprinting only: - -``` yaml -walking: - type: "walking" - distance: 1000 # distance in blocks travelled - mode: running # (OPTIONAL) specific mode of transport - worlds: # (OPTIONAL) restrict to certain worlds - - "world" -``` diff --git a/docs/task-types/askyblock_level-(task-type).md b/docs/task-types/askyblock_level-(task-type).md new file mode 100644 index 00000000..823a79a6 --- /dev/null +++ b/docs/task-types/askyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: askyblock_level +parent: Task types +nav_order: 27 +--- + +# askyblock_level (task type) + +Since v1.7.1 +{: .label .label-green } + +Plugin 'ASkyBlock' required +{: .label } + +Reach a certain ASkyBlock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +askyblock: + type: "askyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/bentobox_level-(task-type).md b/docs/task-types/bentobox_level-(task-type).md new file mode 100644 index 00000000..933ee21d --- /dev/null +++ b/docs/task-types/bentobox_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: bentobox_level +parent: Task types +nav_order: 28 +--- + +# bentobox_level (task type) + +Since v2.12 +{: .label .label-green } + +Plugin 'BentoBox' required +{: .label } + +Reach a certain BentoBox level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +bentobox: + type: "bentobox_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/blockbreak-(task-type).md b/docs/task-types/blockbreak-(task-type).md new file mode 100644 index 00000000..66595b5a --- /dev/null +++ b/docs/task-types/blockbreak-(task-type).md @@ -0,0 +1,71 @@ +--- +title: blockbreak +parent: Task types +nav_order: 1 +--- + +# blockbreak (task type) + +Since v1.0 +{: .label .label-green } + +Break a set amount of blocks. + +{: .note } +Since Quests v3.13, `blockbreakcertain` and `blockbreak` have been +merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------------------|------------------------------------------------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of blocks to break. | Integer | Yes | \- | \- | +| `block` | The specific blocks to break. | Material, or list of materials | No | \- | Not specifying this field will allow all blocks to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for block names. | +| `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | +| `reverse-if-placed` | Whether placing blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | +| `check-coreprotect` | Whether the plugin should query CoreProtect if a block has been recently placed. | Boolean | No | false | This requires the CoreProtect plugin. | +| `check-coreprotect-time` | How long ago (in seconds) the plugin should check with CoreProtect whether a block was placed. | Integer | No | \- | This requires the CoreProtect plugin. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Break 10 of any block: + +``` yaml +mining: + type: "blockbreak" + amount: 10 # amount of blocks to be broken + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Break 10 of stone: + +``` yaml +miningstone: + type: "blockbreakcertain" + amount: 10 # amount of blocks to be brkoen + block: STONE # name of block (can be id or minecraft name) + data: 1 # (OPTIONAL) data code + reverse-if-placed: false # (OPTIONAL) if true, blocks of same type placed will reverse progression (prevents silk-touch exploit) + check-coreprotect: false # (OPTIONAL) if true and CoreProtect is present, the plugin will check its logs for player placed blocks + check-coreprotect-time: 3600 # (OPTIONAL) time in seconds for the maximum logging period to check + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Break 10 of either stone or gold ore: + +``` yaml +miningmultiple: + type: "blockbreakcertain" + amount: 10 # amount of blocks to be placed + blocks: # name of blocks which will count towards progress + - STONE + - GOLD_ORE + reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) + check-coreprotect: false # (OPTIONAL) if true and CoreProtect is present, the plugin will check its logs for player placed blocks + check-coreprotect-time: 3600 # (OPTIONAL) time in seconds for the maximum logging period to check + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/blockplace-(task-type).md b/docs/task-types/blockplace-(task-type).md new file mode 100644 index 00000000..e39538c8 --- /dev/null +++ b/docs/task-types/blockplace-(task-type).md @@ -0,0 +1,65 @@ +--- +title: blockplace +parent: Task types +nav_order: 2 +--- + +# blockplace (task type) + +Since v1.0 +{: .label .label-green} + +Place a set amount of blocks. + +{: .note } +Since Quests v3.13, `blockplacecertain` and `blockplace` have been +merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------------|-------------------------------------------------------------------|--------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of blocks to place. | Integer | Yes | \- | \- | +| `block` | The specific blocks to place. | Material, or list of materials | No | \- | Not specifying this field will allow all blocks to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for block names. | +| `data` | The data code for the block. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with lists of blocks. | +| `reverse-if-broken` | Whether breaking blocks should decrement from the quest progress. | Boolean | No | false | This allows negative quest progresses. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Place 10 of any block: + +``` yaml +building: + type: "blockplace" + amount: 10 # amount of blocks to be placed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Place 10 of stone: + +``` yaml +buildingstone: + type: "blockplace" + amount: 10 # amount of blocks to be placed + block: STONE # name of block (minecraft name) + data: 1 # (OPTIONAL) data code + reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Place 10 of either stone or gold ore: + +``` yaml +buildingmultiple: + type: "blockplace" + amount: 10 # amount of blocks to be placed + blocks: # name of blocks which will count towards progress + - STONE + - GOLD_ORE + reverse-if-broken: false # (OPTIONAL) if true, blocks of same type broken will reverse progression (prevents silk-touch exploit) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/breeding-(task-type).md b/docs/task-types/breeding-(task-type).md new file mode 100644 index 00000000..66459f7d --- /dev/null +++ b/docs/task-types/breeding-(task-type).md @@ -0,0 +1,31 @@ +--- +title: breeding +parent: Task types +nav_order: 3 +--- + +# breeding (task type) + +Since v2.2 +{: .label .label-green } + +Breed a certain amount of animals. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of animals to breed. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Breed 5 animals: + +``` yaml +breeding: + type: "breeding" + amount: 5 # amount of animals bred + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/brewing-(task-type).md b/docs/task-types/brewing-(task-type).md new file mode 100644 index 00000000..312e3dfb --- /dev/null +++ b/docs/task-types/brewing-(task-type).md @@ -0,0 +1,31 @@ +--- +title: brewing +parent: Task types +nav_order: 4 +--- + +# brewing (task type) + +Since v2.0.13 +{: .label .label-green } + +Brew a set amount of potions. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of potions to brew. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Brew 8 potions: + +``` yaml +brewing: + type: "brewing" + amount: 10 # amount of potions brewed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/bucketempty-(task-type).md b/docs/task-types/bucketempty-(task-type).md new file mode 100644 index 00000000..49806d17 --- /dev/null +++ b/docs/task-types/bucketempty-(task-type).md @@ -0,0 +1,33 @@ +--- +title: bucketempty +parent: Task types +nav_order: 5 +--- + +# bucketempty (task type) + +Since v3.9 +{: .label .label-green } + +Empty a bucket. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of buckets to empty. | Integer | Yes | \- | \- | +| `item` | The specific bucket to empty. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Empty 8 lava buckets: + +``` yaml +bucketempty : + type: "bucketempty" + bucket: LAVA_BUCKET # bucket to empty + amount: 8 # amount of times to empty + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/bucketfill-(task-type).md b/docs/task-types/bucketfill-(task-type).md new file mode 100644 index 00000000..3648d06e --- /dev/null +++ b/docs/task-types/bucketfill-(task-type).md @@ -0,0 +1,33 @@ +--- +title: bucketfill +parent: Task types +nav_order: 6 +--- + +# bucketfill (task type) + +Since v3.9 +{: .label .label-green } + +Fill a bucket up. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of buckets to fill. | Integer | Yes | \- | \- | +| `item` | The specific bucket to fill. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Fill 8 lava buckets: + +``` yaml +bucketfill: + type: "bucketfill" + bucket: LAVA_BUCKET # bucket to fill + amount: 8 # amount of times to fill + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/citizens_deliver-(task-type).md b/docs/task-types/citizens_deliver-(task-type).md new file mode 100644 index 00000000..bc3cb6f3 --- /dev/null +++ b/docs/task-types/citizens_deliver-(task-type).md @@ -0,0 +1,80 @@ +--- +title: citizens_deliver +parent: Task types +nav_order: 29 +--- + +# citizens_deliver (task type) + +Since v2.0.15 +{: .label .label-green } + +Plugin 'Citizens' required +{: .label } + +Deliver a set of items to a Citizens NPC. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to deliver. | Integer | Yes | \- | \- | +| `item` | The specific item to deliver. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | +| `remove-items-when-complete` | Whether the items should be taken from the player when complete. | Boolean | No | false | If `allow-partial-completion` is true, then this will also be set to true. | +| `allow-partial-completion` | Whether any number of items counts towards the task progress. | Boolean | No | true | Setting to true will force `remove-items-when-complete` to true as well. If a player obtains any matching item, it will be immediately taken away from them and added towards the quest progress. | +| `npc-name` | The name of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-id`. | +| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Deliver 8 of `BEEF` to an NPC named Gerald: + +``` yaml +citizensdeliver: + type: "citizens_deliver" + npc-name: "Gerald" # name of NPC + # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) + item: BEEF # name of item (can be id or minecraft name) + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Deliver 8 of a specific item to an NPC named Gerald: + +``` yaml +beef: + type: "citizens_deliver" + npc-name: "Gerald" # name of NPC + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "BEEF" + lore: + - "&7This is a special type of beef" + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + accept-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Deliver 8 of [quest item](../configuration/defining-items#quest-items) +`special_beef` to an NPC named Gerald: + +``` yaml +beef: + type: "citizens_deliver" + npc-name: "Gerald" # name of NPC + # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) + item: # USING quest-item + quest-item: "special_beef" + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + accept-partial-completion: false # (OPTIONAL) allow partial deliveries - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/citizens_interact-(task-type).md b/docs/task-types/citizens_interact-(task-type).md new file mode 100644 index 00000000..f25e9844 --- /dev/null +++ b/docs/task-types/citizens_interact-(task-type).md @@ -0,0 +1,36 @@ +--- +title: citizens_interact +parent: Task types +nav_order: 30 +--- + +# citizens_interact (task type) + +Since v2.0.15 +{: .label .label-green } + +Plugin 'Citizens' required +{: .label } + +Interact with a Citizens NPC. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------|-------------------------------------------------|---------------------|----------|---------|-------------------------------------| +| `npc-name` | The name of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-id`. | +| `npc-id` | The id of the NPC to deliver to. | Boolean | No | \- | Mutually exclusive with `npc-name`. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Interact with an NPC named Gerald: + +``` yaml +citizensinteract: + type: "citizens_interact" + npc-name: "Gerald" # name of NPC + # OR npc-id: "npc1" ID of NPC (mutally exclusive with npc-name) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/command-(task-type).md b/docs/task-types/command-(task-type).md new file mode 100644 index 00000000..4e2d426f --- /dev/null +++ b/docs/task-types/command-(task-type).md @@ -0,0 +1,36 @@ +--- +title: command +parent: Task types +nav_order: 7 +--- + +# command (task type) + +Since v2.12 +{: .label .label-green } + +Execute a specific command. + +This task may not work for commands not properly registered with the +server (e.g. commands made with plugins like DeluxeMenu). + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|------------------------------------------------------|---------------------|----------|---------|-------| +| `command` | The command to execute. | String | Yes | \- | \- | +| `ignore-case` | Whether the casing of the command should be ignored. | Boolean | No | false | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Ask for help: + +``` yaml +command: + type: "command" + command: "help" # command to execute + ignore-case: true # (OPTIONAL) ignore capitalisation - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/consume-(task-type).md b/docs/task-types/consume-(task-type).md new file mode 100644 index 00000000..a5e23d13 --- /dev/null +++ b/docs/task-types/consume-(task-type).md @@ -0,0 +1,64 @@ +--- +title: consume +parent: Task types +nav_order: 8 +--- + +# consume (task type) + +Since v3.9 +{: .label .label-green } + +Consume a specific item. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to consume. | Integer | Yes | \- | \- | +| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Consume 8 of `BEEF`: + +``` yaml +beef: + type: "consume" + item: BEEF # name of item (can be id or minecraft name) + amount: 8 # amount of item consumed + data: 0 # (OPTIONAL) data code + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Consume 8 of a specific item: + +``` yaml +beef: + type: "consume" + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "RAW_BEEF" + lore: + - "&7This is a special type of beef" + amount: 8 # amount of item consumed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Consume 8 of [quest item](../configuration/defining-items#quest-items) +`special_beef`: + +``` yaml +beef: + type: "consume" + item: # USING quest-item + quest-item: "special_beef" + amount: 8 # amount of item needed + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/crafting-(task-type).md b/docs/task-types/crafting-(task-type).md new file mode 100644 index 00000000..14c9e8fb --- /dev/null +++ b/docs/task-types/crafting-(task-type).md @@ -0,0 +1,63 @@ +--- +title: crafting +parent: Task types +nav_order: 9 +--- + +# crafting (task type) + +Since v3.0 +{: .label .label-green } + +Craft a set of items. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to craft. | Integer | Yes | \- | \- | +| `item` | The specific item to craft. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Craft 5 of `COMPASS`: + +``` yaml +compass: + type: "crafting" + item: COMPASS # name of item (can be id or minecraft name) + amount: 5 # amount of item needed + data: 0 # (OPTIONAL) data code + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Craft 5 of a specific item: + +``` yaml +compass: + type: "crafting" + item: # SPECIFIC item with name and lore + name: "&cSuper Compass" + type: "COMPASS" + lore: + - "&7This is special compass with a fancy name" + amount: 5 # amount of item needed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Craft 5 of [quest item](../configuration/defining-items#quest-items) +`super_compass`: + +``` yaml +compass: + type: "crafting" + item: # USING quest-item + quest-item: "super_compass" + amount: 5 # amount of item needed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/dealdamage-(task-type).md b/docs/task-types/dealdamage-(task-type).md new file mode 100644 index 00000000..426f76e2 --- /dev/null +++ b/docs/task-types/dealdamage-(task-type).md @@ -0,0 +1,31 @@ +--- +title: dealdamage +parent: Task types +nav_order: 10 +--- + +# dealdamage (task type) + +Since v2.2 +{: .label .label-green } + +Deal a certain amount of damage. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------------------------------------------------| +| `amount` | The amount of damage needed. | Integer | Yes | \- | Damage is measured in HP, 1 heart = 2 HP. A player has 20 HP by default, with no status effects applied. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Deal 100 HP of damage: + +``` yaml +dealdamage: + type: "dealdamage" + amount: 100 # amount of damage inflicted (HP) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/distancefrom-(task-type).md b/docs/task-types/distancefrom-(task-type).md new file mode 100644 index 00000000..5c0e8305 --- /dev/null +++ b/docs/task-types/distancefrom-(task-type).md @@ -0,0 +1,36 @@ +--- +title: distancefrom +parent: Task types +nav_order: 11 +--- + +# distancefrom (task type) + +Since v2.12 +{: .label .label-green } + +Travel away from a set of co-ordinates. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------|-----------------------------------------------------------------|---------|----------|---------|-------| +| `x` | The x co-ordinate. | Integer | Yes | \- | \- | +| `y` | The y co-ordinate. | Integer | Yes | \- | \- | +| `z` | The z co-ordinate. | Integer | Yes | \- | \- | +| `world` | The name of the world. | String | Yes | \- | \- | +| `distance` | The distance away from the co-ordinates the player must travel. | Integer | Yes | \- | \- | + +## Examples + +Travel at least 10 blocks away from (0, 0, 0) in world: + +``` yaml +distancefrom: + type: "distancefrom" + x: 0 # x position + y: 0 # y position + z: 0 # z position + world: world # name of world + distance: 10 # required distance from coordinates +``` diff --git a/docs/task-types/enchanting-(task-type).md b/docs/task-types/enchanting-(task-type).md new file mode 100644 index 00000000..1e2b6c80 --- /dev/null +++ b/docs/task-types/enchanting-(task-type).md @@ -0,0 +1,57 @@ +--- +title: enchanting +parent: Task types +nav_order: 12 +--- + +# enchanting (task type) + +Since v2.2 +{: .label .label-green } + +Enchant an item. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|-------------------------------------------------|--------------------------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | +| `item` | The specific item to encahnt. | Material, or ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. If no item is specified, then any item can be enchanted. | +| `enchantment` | The specific enchantment(s) to apply. | Enchantment, or list of enchantments | No | \- | If no enchantments are specified, then any enchantment can be applied. | +| `min-level` | The minimum level of the enchantments. | Integer | No | \- | If no minimum level is specified, then any enchantment of any level can be applied. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Enchant 10 items: + +``` yaml +enchanting: + type: "enchanting" + amount: 10 # amount of items enchanted + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Enchant 10 items with Protection: + +``` yaml +beef: + type: "enchanting" + amount: 10 # amount of items + enchantment: PROTECTION_ENVIRONMENTAL # (OPTIONAL) enchantment to apply + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Enchant 10 items with Protection IV: + +``` yaml +beef: + type: "enchanting" + amount: 10 # amount of items + enchantment: PROTECTION_ENVIRONMENTAL # (OPTIONAL) enchantment to apply + min-level: 4 # (OPTIONAL) the minimum level of enchantment to apply + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/essentials_balance-(task-type).md b/docs/task-types/essentials_balance-(task-type).md new file mode 100644 index 00000000..6d246376 --- /dev/null +++ b/docs/task-types/essentials_balance-(task-type).md @@ -0,0 +1,31 @@ +--- +title: essentials_balance +parent: Task types +nav_order: 31 +--- + +# essentials_balance (task type) + +Since v2.12 +{: .label .label-green } + +Plugin 'Essentials' required +{: .label } + +Reach a certain balance. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|----------------------|---------|----------|---------|-------| +| `amount` | The amount to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach a balance of \$1000: + +``` yaml +essentialsbalance: + type: "essentials_balance" + amount: 1000 # amount of money to rach +``` diff --git a/docs/task-types/essentials_moneyearn-(task-type).md b/docs/task-types/essentials_moneyearn-(task-type).md new file mode 100644 index 00000000..eba692fa --- /dev/null +++ b/docs/task-types/essentials_moneyearn-(task-type).md @@ -0,0 +1,31 @@ +--- +title: essentials_moneyearn +parent: Task types +nav_order: 32 +--- + +# essentials_moneyearn (task type) + +Since v2.12 +{: .label .label-green } + +Plugin 'Essentials' required +{: .label } + +Earn a certain amount of money after starting quest. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|---------------------|---------|----------|---------|-------| +| `amount` | The amount to earn. | Integer | Yes | \- | \- | + +## Examples + +Earn \$1000: + +``` yaml +essentialsbalance: + type: "essentials_moneyearn" + amount: 1000 # amount of money to earn +``` diff --git a/docs/task-types/expearn-(task-type).md b/docs/task-types/expearn-(task-type).md new file mode 100644 index 00000000..86cbf5ca --- /dev/null +++ b/docs/task-types/expearn-(task-type).md @@ -0,0 +1,31 @@ +--- +title: expearn +parent: Task types +nav_order: 13 +--- + +# expearn (task type) + +Since v2.2 +{: .label .label-green } + +Earn a set amount of exp after starting the quest. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The amount of experience to earn. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Earn 20 experience: + +``` yaml +expearn: + type: "expearn" + amount: 20 # amount of experience earned + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/fabledskyblock_level-(task-type).md b/docs/task-types/fabledskyblock_level-(task-type).md new file mode 100644 index 00000000..eecf2dc0 --- /dev/null +++ b/docs/task-types/fabledskyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: fabledskyblock_level +parent: Task types +nav_order: 33 +--- + +# fabledskyblock_level (task type) + +Since v3.5 +{: .label .label-green } + +Plugin 'FabledSkyblock' required +{: .label } + +Reach a certain FabledSkyblock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +fabledskyblock: + type: "fabledskyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/farming-(task-type).md b/docs/task-types/farming-(task-type).md new file mode 100644 index 00000000..4207f903 --- /dev/null +++ b/docs/task-types/farming-(task-type).md @@ -0,0 +1,66 @@ +--- +title: farming +parent: Task types +nav_order: 14 +--- + +# farming (task type) + +Since v3.5 +{: .label .label-green } + +Minecraft 1.13+ required +{: .label .label-purple } + +*For previous versions, use [blockbreak](blockbreak-(task-type)).* + +Farm a set amount of crops. + +{: .note } +Since Quests v3.13, `farmingcertain` and `farming` have been merged into +one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|-------------------------------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of crops to farm. | Integer | Yes | \- | \- | +| `block` | The specific crop(s) to farm. | Material, or list of material | No | \- | Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. Note that some items are confusingly named, they may refer to the held item or block instead of the crop block. | +| `mode` | The mode to harvest crops. | String | No | \- | One of: `break`, `harvest`. A harvest is where a block drops an item (usually a crop) but does not change state. If this is not specified, both will be accepted. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Farm 10 crops: + +``` yaml +farming: + type: "farming" + amount: 10 # amount of blocks to be broken + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Farm 10 wheat: + +``` yaml +farming: + type: "farming" + amount: 10 # amount of blocks to be brkoen + block: WHEAT # name of block (can be id or minecraft name) + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Farm 10 wheat or beetroot: + +``` yaml +farmingmultiple: + type: "farming" + amount: 10 # amount of blocks to be placed + blocks: # name of blocks which will count towards progress + - WHEAT + - BEETROOT + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/fishing-(task-type).md b/docs/task-types/fishing-(task-type).md new file mode 100644 index 00000000..659a6521 --- /dev/null +++ b/docs/task-types/fishing-(task-type).md @@ -0,0 +1,60 @@ +--- +title: fishing +parent: Task types +nav_order: 15 +--- + +# fishing (task type) + +Since v2.0 +{: .label .label-green } + +Fish a set amount of items. + +{: .note } +Since Quests v3.13, `fishingcertain` and `fishing` have been merged into +one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|--------------------------------------------------|---------------------|----------|---------|----------------------------------------------------------------| +| `amount` | The number of fish to catch. | Integer | Yes | \- | \- | +| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Fish 10 of any item: + +``` yaml +fishing: + type: "fishing" + amount: 10 # amount of fish caught + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Fish 10 pufferfish: + +``` yaml +fishingcertain: + type: "fishingcertain" + item: PUFFERFISH # type of item caught + amount: 10 # amount of item caught + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Fish 10 of [quest item](../configuration/defining-items#quest-items) +`super_fish`: + +``` yaml +fishingcertain: + type: "fishingcertain" + item: # type of item caught + quest-item: "super_fish" + amount: 10 # amount of item caught + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/index.md b/docs/task-types/index.md new file mode 100644 index 00000000..4b0e657f --- /dev/null +++ b/docs/task-types/index.md @@ -0,0 +1,7 @@ +--- +title: Task types +has_children: true +nav_order: 6 +--- + +# Task types \ No newline at end of file diff --git a/docs/task-types/inventory-(task-type).md b/docs/task-types/inventory-(task-type).md new file mode 100644 index 00000000..a240207a --- /dev/null +++ b/docs/task-types/inventory-(task-type).md @@ -0,0 +1,74 @@ +--- +title: inventory +parent: Task types +nav_order: 16 +--- + +# inventory (task type) + +Since v1.4 +{: .label .label-green } + + +Obtain a set of items. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------------------------|------------------------------------------------------------------|------------------------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to obtain. | Integer | Yes | \- | \- | +| `item` | The specific item to obtain. | Material, or ItemStack | Yes | \- | Accepts standard [item definition](defining_items "wikilink"). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. | +| `data` | The data code for the item. | Integer | No | 0 | This field is not used in Minecraft versions 1.13+, nor is it compatible with ItemStack definitions. | +| `remove-items-when-complete` | Whether the items should be taken from the player when complete. | Boolean | No | false | If `allow-partial-completion` is true, then this will also be set to true. | +| `allow-partial-completion` | Whether any number of items counts towards the task progress. | Boolean | No | true | Setting to true will force `remove-items-when-complete` to true as well. If a player obtains any matching item, it will be immediately taken away from them and added towards the quest progress. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Obtain 8 of `BEEF`: + +``` yaml +beef: + type: "inventory" + item: BEEF # name of item (can be id or minecraft name) + amount: 8 # amount of item needed + data: 0 # (OPTIONAL) data code + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Obtain 8 of a specific item: + +``` yaml +beef: + type: "inventory" + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "RAW_BEEF" + lore: + - "&7This is a special type of beef" + amount: 8 # amount of item needed + data: 0 # (OPTIONAL) data code + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Obtain 8 of [quest item](../configuration/defining-items#quest-items) +`special_beef`: + +``` yaml +beef: + type: "inventory" + item: # USING quest-item + quest-item: "specialbeef" + amount: 8 # amount of item needed + data: 0 # (OPTIONAL) data code + remove-items-when-complete: false # (OPTIONAL) take the items away from the player on completion - default: false + allow-partial-completion: false # (OPTIONAL) allow partial deliveries - default: true + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/iridiumskyblock_value-(task-type).md b/docs/task-types/iridiumskyblock_value-(task-type).md new file mode 100644 index 00000000..40ca8a8c --- /dev/null +++ b/docs/task-types/iridiumskyblock_value-(task-type).md @@ -0,0 +1,31 @@ +--- +title: iridiumskyblock_value +parent: Task types +nav_order: 34 +--- + +# iridiumskyblock_value (task type) + +Since v3.5 +{: .label .label-green } + +Plugin 'IridiumSkyblock' required - version 2.x only +{: .label } + +Reach a certain IridiumSkyblock value. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|--------------------|---------|----------|---------|-------| +| `value` | The valueto reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island value 10: + +``` yaml +iridiumskyblock: + type: "iridiumskyblock_value" + value: 10 # island level needed +``` diff --git a/docs/task-types/milking-(task-type).md b/docs/task-types/milking-(task-type).md new file mode 100644 index 00000000..75c2ed86 --- /dev/null +++ b/docs/task-types/milking-(task-type).md @@ -0,0 +1,31 @@ +--- +title: milking +parent: Task types +nav_order: 17 +--- + +# milking (task type) + +Since v2.0 +{: .label .label-green } + +Milk a set amount of cows. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of cows to milk. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Milk 10 cows: + +``` yaml +milking: + type: "milking" + amount: 10 # amount of cows milked + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/mobkilling-(task-type).md b/docs/task-types/mobkilling-(task-type).md new file mode 100644 index 00000000..f0a5c50b --- /dev/null +++ b/docs/task-types/mobkilling-(task-type).md @@ -0,0 +1,103 @@ +--- +title: mobkilling +parent: Task types +nav_order: 18 +--- + +# mobkilling (task type) + +Since v2.0 +{: .label .label-green } + +Kill a set amount of mobs. + +{: .note } +Since Quests v3.13, `mobkillingcertain` and `mobkilling` have been +merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------------|--------------------------------------------------|----------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | +| `mob` | The specific mob(s) to kill. | Entity type, or list of entities | No | \- | Not specifying this field will allow all mob types to count towards the task. Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) for entity types. | +| `name` / `names` | The specific name(s) of mobs to kill. | String, or list of strings | No | \- | Not specifying this field will allow mobs with any names to count towards the task. Ensure any colour codes in the name of the entity are specified, otherwise the match will not work. | +| `hostile` | Whether the mob must be hostile. | Boolean | No | \- | If specified and set to false, only non-hostile mobs will count. | +| `item` | Specific item which should be used to kill mobs. | ItemStack | No | \- | Accepts standard [item definition](defining_items "wikilink"). | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 10 of any mob: + +``` yaml +mobkilling: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + hostile: true # (OPTIONAL) whether or not the mob is hostile - default: both + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blaze named (red) "Inferno": + +``` yaml +mobkillingblaze: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: BLAZE # (OPTIONAL) type of mob + name: &cInferno # (OPTIONAL) this only allows blazes called "&cInferno" - default: any name + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blade named either (red) "Inferno" or (orange) "Furnace": + +``` yaml +mobkillingblazemultiple: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: BLAZE # (OPTIONAL) type of mob + names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name + - "&cInferno" + - "&6Furnace" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blaze or creeper named either (red) "Inferno" or (orange) +"Furnace": + +``` yaml +mobkillingblazemultiple: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: # (OPTIONAL) types of mobs + - BLAZE + - CREEPER + names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name + - "&cInferno" + - "&6Furnace" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Kill 10 of a blaze or creeper named either (red) "Inferno" or (orange) +"Furnace" with [quest item](../configuration/defining-items#quest-items) +"super_sword": + +``` yaml +mobkillingblazecreepermultiple: + type: "mobkilling" + amount: 10 # amount of mobs to be killed + mob: # (OPTIONAL) types of mobs + - BLAZE + - CREEPER + names: # (OPTIONAL) this only allows blazes called "&cInferno" OR "&6Furnace" - default: any name + - "&cInferno" + - "&6Furnace" + item: # (OPTIONAL) specific item to kill with + quest-item: "super_sword" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/mythicmobs_killing-(task-type).md b/docs/task-types/mythicmobs_killing-(task-type).md new file mode 100644 index 00000000..4862f66d --- /dev/null +++ b/docs/task-types/mythicmobs_killing-(task-type).md @@ -0,0 +1,40 @@ +--- +title: mythicmobs_killing +parent: Task types +nav_order: 35 +--- + +# mythicmobs_killing (task type) + +Since v2.3 +{: .label .label-green } + +Plugin 'MythicMobs' required +{: .label } + +Kill a certain MythicMobs mob. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|-------------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of mobs to kill. | Integer | Yes | \- | \- | +| `name` | The MythicMob ID. | String | Yes | \- | \- | +| `level` | The level the mob must be at. | Integer | Yes | \- | \- | +| `min-level` | The minimum level the mob must be at. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 1 mythic mob with the ID "SkeletalKnight": + +``` yaml +mythicmobs: + type: "mythicmobs_killing" + amount: 1 # amount of mobs to be killed + name: "SkeletalKnight" # internal name of mob (name in config - NOT display name) + level: 1 # (OPTIONAL) the exact level the mob must be for it to count + min-level: 1 # (OPTIONAL) the minimum level the mob must be for it to count + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/permission-(task-type).md b/docs/task-types/permission-(task-type).md new file mode 100644 index 00000000..aa55c00a --- /dev/null +++ b/docs/task-types/permission-(task-type).md @@ -0,0 +1,30 @@ +--- +title: permission +parent: Task types +nav_order: 19 +--- + +# permission (task type) + +Since v2.9.5 +{: .label .label-green } + +Test if a player has a permission. + +This task works by regularly polling a player at a certain interval. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------|----------------------------------------|--------|----------|---------|-------| +| `permission` | The permission the player should have. | String | Yes | \- | \- | + +## Examples + +Check if player has permission `some.permission.name`: + +``` yaml +permission: + type: "permission" + permission: "some.permission.name" # permission required to be marked as complete +``` diff --git a/docs/task-types/placeholderapi_evaluate-(task-type).md b/docs/task-types/placeholderapi_evaluate-(task-type).md new file mode 100644 index 00000000..87079d7f --- /dev/null +++ b/docs/task-types/placeholderapi_evaluate-(task-type).md @@ -0,0 +1,49 @@ +--- +title: placeholderapi_evaluate +parent: Task types +nav_order: 36 +--- + +# placeholderapi_evaluate (task type) + +Since v2.9.5 +{: .label .label-green } + +Plugin 'PlaceholderAPI' required +{: .label } + +Evaluate a certain PlaceholderAPI placeholder and compare it against a given condition. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------------|-----------------------------------------------------------|---------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `placeholder` | The placeholder to evaluate. | String | Yes | \- | \- | +| `evaluates` | The string the placeholder should evaluate to. | String | Yes | \- | \- | +| `operator` | The comparative operator to use for numeric placeholders. | String | No | \- | One of: `GREATER_THAN`, `LESS_THAN`, `GREATER_THAN_OR_EQUAL_TO`, `LESS_THAN_OR_EQUAL_TO`. The value in `evaluates` **must** be numeric. If this is not specified, then exact equality will be assumed. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Have a player name of "fatpigsarefat": + +``` yaml +papieval: + type: "placeholderapi_evaluate" + placeholder: "%player_name%" # placeholder string + evaluates: "fatpigsarefat" # what it should evaluate as to be marked as complete + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Be online when there are more than 20 empty slots on the server: + +``` yaml +papieval: + type: "placeholderapi_evaluate" + placeholder: "%player_empty_slots%" # placeholder string + evaluates: "20" # number to compare to + operator: "GREATER_THAN" # (OPTIONAL) numerical operator, "evaluates" MUST be an integer + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/playerkilling-(task-type).md b/docs/task-types/playerkilling-(task-type).md new file mode 100644 index 00000000..4aee13bf --- /dev/null +++ b/docs/task-types/playerkilling-(task-type).md @@ -0,0 +1,32 @@ +--- +title: playerkilling +parent: Task types +nav_order: 20 +--- + +# playerkilling (task type) + +Since v2.0 +{: .label .label-green } + + +Kill a set amount of players. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of players to kill. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Kill 10 of any player: + +``` yaml +killplayers: + type: "playerkilling" + amount: 10 # amount of players to kill + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/playtime-(task-type).md b/docs/task-types/playtime-(task-type).md new file mode 100644 index 00000000..649b0db4 --- /dev/null +++ b/docs/task-types/playtime-(task-type).md @@ -0,0 +1,33 @@ +--- +title: playtime +parent: Task types +nav_order: 21 +--- + +# playtime (task type) + +Since v1.8 +{: .label .label-green } + +Play for a certain amount of time after starting the quest. + +{: .note } +Before Quests v2.0, this task was known as `TIMEPLAYED`. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------|----------------------------------------|---------|----------|---------|----------------------| +| `minutes` | The number of minutes to play. | Integer | Yes | \- | \- | +| `ignore-afk` | Whether AFK players should be ignored. | Boolean | Yes | \- | Requires Essentials. | + +## Examples + +Play for 20 minutes: + +``` yaml +playtime: + type: "playtime" + minutes: 10 # amount of minutes played + ignore-afk: false # (OPTIONAL) ignore players marked as AFK by essentials +``` diff --git a/docs/task-types/position-(task-type).md b/docs/task-types/position-(task-type).md new file mode 100644 index 00000000..bf990ca8 --- /dev/null +++ b/docs/task-types/position-(task-type).md @@ -0,0 +1,36 @@ +--- +title: position +parent: Task types +nav_order: 22 +--- + +# position (task type) + +Since v2.0.3 +{: .label .label-green } + +Reach a set of co-ordinates. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|--------------------|-----------------------------------------------------------|---------|----------|---------|----------------------------------------------------------------------| +| `x` | The x co-ordinate. | Integer | Yes | \- | \- | +| `y` | The y co-ordinate. | Integer | Yes | \- | \- | +| `z` | The z co-ordinate. | Integer | Yes | \- | \- | +| `world` | The name of the world. | String | Yes | \- | \- | +| `distance-padding` | The distance around the co-ordinate the player can reach. | Integer | No | \- | Having no padding means the player must reach the exact co-ordinate. | + +## Examples + +Travel to within 10 blocks of (0, 0, 0) in world: + +``` yaml +position: + type: "position" + x: 0 # x position + y: 0 # y position + z: 0 # z position + world: world # name of world + distance-padding: 10 # (OPTIONAL) padding zone in meters/blocks - this will allow within 10 blocks of 0, 0, 0 - default = 0 +``` diff --git a/docs/task-types/shearing-(task-type).md b/docs/task-types/shearing-(task-type).md new file mode 100644 index 00000000..5c81e1e7 --- /dev/null +++ b/docs/task-types/shearing-(task-type).md @@ -0,0 +1,32 @@ +--- +title: shearing +parent: Task types +nav_order: 23 +--- + +# shearing (task type) + +Since v2.0 +{: .label .label-green } + + +Shear a set amount of sheep. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of sheep to shear. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Shear 10 sheep: + +``` yaml +shearing: + type: "shearing" + amount: 10 # amount of sheep sheared + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/shopguiplus_buy-(task-type).md b/docs/task-types/shopguiplus_buy-(task-type).md new file mode 100644 index 00000000..85c03ae9 --- /dev/null +++ b/docs/task-types/shopguiplus_buy-(task-type).md @@ -0,0 +1,39 @@ +--- +title: shopguiplus_buy +parent: Task types +nav_order: 37 +--- + +# shopguiplus_buy (task type) + +Since v2.15 +{: .label .label-green } + +Plugin 'ShopGUI+' required +{: .label } + +Buy a certain number of items from a ShopGUI+ shop. + +{: .note } +Since Quests v3.13, `shopguiplus_buycertain` and `shopguiplus_buy` have +been merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|-----------|-----------------------------|---------|----------|---------|-------| +| `amount` | The number of items to buy. | Integer | Yes | \- | \- | +| `shop-id` | The ID of the shop. | String | Yes | \- | \- | +| `item-id` | The ID of the item to buy. | String | Yes | \- | \- | + +## Examples + +Buy 1000 of item_id from shop_id: + +``` yaml +shopguiplusbuy: + type: "shopguiplus_buy" + shop-id: "shop_id" # shopgui+ id of the shop that contains the item. + item-id: "item_id" # shopgui+ id of item to sell + amount: 1000 # amount of thing to sell +``` diff --git a/docs/task-types/shopguiplus_sell-(task-type).md b/docs/task-types/shopguiplus_sell-(task-type).md new file mode 100644 index 00000000..a1c94a10 --- /dev/null +++ b/docs/task-types/shopguiplus_sell-(task-type).md @@ -0,0 +1,39 @@ +--- +title: shopguiplus_sell +parent: Task types +nav_order: 38 +--- + +# shopguiplus_sell (task type) + +Since v2.15 +{: .label .label-green } + +Plugin 'ShopGUI+' required +{: .label } + +Sell a certain number of items to a ShopGUI+ shop. + +{: .note } +Since Quests v3.13, `shopguiplus_sellcertain` and `shopguiplus_sell` +have been merged into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|-----------|------------------------------|---------|----------|---------|-------| +| `amount` | The number of items to sell. | Integer | Yes | \- | \- | +| `shop-id` | The ID of the shop. | String | Yes | \- | \- | +| `item-id` | The ID of the item to sell. | String | Yes | \- | \- | + +## Examples + +Sell 1000 of item_id to shop_id: + +``` yaml +shopguiplussell: + type: "shopguiplus_sell" + shop-id: "shop_id" # shopgui+ id of the shop that contains the item. + item-id: "item_id" # shopgui+ id of item to sell + amount: 1000 # amount of thing to sell +``` diff --git a/docs/task-types/smelting-(task-type).md b/docs/task-types/smelting-(task-type).md new file mode 100644 index 00000000..721740c5 --- /dev/null +++ b/docs/task-types/smelting-(task-type).md @@ -0,0 +1,76 @@ +--- +title: smelting +parent: Task types +nav_order: 24 +--- + +# smelting (task type) + +Since v3.12 +{: .label .label-green } + +Cook a set amount of an item. + +{: .note } +Since Quests v3.13, `smeltingcertain` and `smelting` have been merged +into one. Both names can be used to refer to this task. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|------------------------|----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `amount` | The number of items to smelt. | Integer | Yes | \- | \- | +| `item` | The specific item to smelt. | Material, or ItemStack | No | \- | Accepts standard [item definition](../configuration/defining-items). Please see [this list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html) (1.13+) or [this list](https://helpch.at/docs/1.12.2/org/bukkit/Material.html) (1.8-1.12) for material names. If this is not specified, any item will count. | +| `mode` | The specific mode of smelting. | String | No | \- | One of: `smoker`, `blast_furnace`, `furnace`. If this is not specified, any furnace will count. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Smelt 10 items: + +``` yaml +smelting: + type: "smelting" + amount: 10 # amount to smelt + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Cook 10 steak: + +``` yaml +smeltingcertain: + type: "smeltingcertain" + amount: 10 # amount to smelt + item: STEAK # type of item + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Cook 10 of a specific item: + +``` yaml +smeltingcertain: + type: "smeltingcertain" + amount: 10 # amount to smelt + item: # SPECIFIC item with name and lore + name: "&cSpecial Beef" + type: "RAW_BEEF" + lore: + - "&7This is a special type of beef" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Cook 10 of [quest item](../configuration/defining-items#quest-items) +`special_beef`: + +``` yaml +smeltingcertain: + type: "smeltingcertain" + amount: 10 # amount to smelt + item: # type of item + quest-item: "special_beef" + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/superiorskyblock_level-(task-type).md b/docs/task-types/superiorskyblock_level-(task-type).md new file mode 100644 index 00000000..c23996b6 --- /dev/null +++ b/docs/task-types/superiorskyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: superiorskyblock_level +parent: Task types +nav_order: 39 +--- + +# superiorskyblock_level (task type) + +Since v3.7 +{: .label .label-green } + +Plugin 'SuperiorSkyblock' required +{: .label } + +Reach a certain SuperiorSkyblock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +superiorskyblock: + type: "superiorskyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/superiorskyblock_worth-(task-type).md b/docs/task-types/superiorskyblock_worth-(task-type).md new file mode 100644 index 00000000..a47d50fe --- /dev/null +++ b/docs/task-types/superiorskyblock_worth-(task-type).md @@ -0,0 +1,31 @@ +--- +title: superiorskyblock_worth +parent: Task types +nav_order: 40 +--- + +# superiorskyblock_worth (task type) + +Since v3.7 +{: .label .label-green } + +Plugin 'SuperiorSkyblock' required +{: .label } + +Reach a certain SuperiorSkyblock worth. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `worth` | The worth to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island worth 100: + +``` yaml +superiorskyblock: + type: "superiorskyblock_worth" + level: 100 # island worth needed +``` diff --git a/docs/task-types/taming-(task-type).md b/docs/task-types/taming-(task-type).md new file mode 100644 index 00000000..1847bda4 --- /dev/null +++ b/docs/task-types/taming-(task-type).md @@ -0,0 +1,31 @@ +--- +title: taming +parent: Task types +nav_order: 25 +--- + +# taming (task type) + +Since v3.13 +{: .label .label-green } + +Tame a set amount of animals. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|-------------------------------------------------|---------------------|----------|---------|-------| +| `amount` | The number of animals to tame. | Integer | Yes | \- | \- | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Tame 10 animals: + +``` yaml +taming: + type: "taming" + amount: 10 # amount of mobs tamed + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/task-types/uskyblock_level-(task-type).md b/docs/task-types/uskyblock_level-(task-type).md new file mode 100644 index 00000000..729ca5c6 --- /dev/null +++ b/docs/task-types/uskyblock_level-(task-type).md @@ -0,0 +1,31 @@ +--- +title: uskyblock_level +parent: Task types +nav_order: 41 +--- + +# uskyblock_level (task type) + +Since v1.7.1 +{: .label .label-green } + +Plugin 'uSkyBlock' required +{: .label } + +Reach a certain uSkyBlock level. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|---------|---------------------|---------|----------|---------|-------| +| `level` | The level to reach. | Integer | Yes | \- | \- | + +## Examples + +Reach island level 10: + +``` yaml +askyblock: + type: "uskyblock_level" + level: 10 # island level needed +``` diff --git a/docs/task-types/votingplugin_vote-(task-type).md b/docs/task-types/votingplugin_vote-(task-type).md new file mode 100644 index 00000000..6a17abac --- /dev/null +++ b/docs/task-types/votingplugin_vote-(task-type).md @@ -0,0 +1,31 @@ +--- +title: votingplugin_vote +parent: Task types +nav_order: 42 +--- + +# votingplugin_vote (task type) + +Since v3.7 +{: .label .label-green } + +Plugin 'VotingPlugin' required +{: .label } + +Vote a number of times using VotingPlugin. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|----------|----------------------|---------|----------|---------|-------| +| `amount` | The number of votes. | Integer | Yes | \- | \- | + +## Examples + +Vote 10 times: + +``` yaml +votingplugin: + type: "votingplugin_vote" + amount: 10 # number of times to vote +``` diff --git a/docs/task-types/walking-(task-type).md b/docs/task-types/walking-(task-type).md new file mode 100644 index 00000000..4c38fc27 --- /dev/null +++ b/docs/task-types/walking-(task-type).md @@ -0,0 +1,43 @@ +--- +title: walking +parent: Task types +nav_order: 26 +--- + +# walking (task type) + +Since v2.0 +{: .label .label-green } + +Walk a set distance. + +## Options + +| Key | Description | Type | Required | Default | Notes | +|------------|-------------------------------------------------|---------------------|----------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `distance` | The distance in metres to walk. | Integer | Yes | \- | 1 metre is equivalent to 1 block. | +| `mode` | The specific mode to travel | String | No | \- | One of: `boat`, `horse`, `pig`, `minecart` `strider`, `sneaking`, `walking`, `running`, `swimming`, `flying`, `elytra`. Not specifying a mode will allow any of these modes to count. | +| `worlds` | Worlds which should count towards the progress. | List of world names | No | \- | \- | + +## Examples + +Travel 1000 metres: + +``` yaml +walking: + type: "walking" + distance: 1000 # distance in blocks travelled + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` + +Travel 1000 metres by sprinting only: + +``` yaml +walking: + type: "walking" + distance: 1000 # distance in blocks travelled + mode: running # (OPTIONAL) specific mode of transport + worlds: # (OPTIONAL) restrict to certain worlds + - "world" +``` diff --git a/docs/tools/data-migration-tool.md b/docs/tools/data-migration-tool.md index 891862c7..7c456f8e 100644 --- a/docs/tools/data-migration-tool.md +++ b/docs/tools/data-migration-tool.md @@ -6,7 +6,7 @@ parent: Tools # Data migration tool The **data migration tool** is a tool that allows you to migrate your -data from one [storage provider](Storage_providers "wikilink") to +data from one [storage provider](../configuration/storage-providers) to another. This can also be used as a backup tool. The tool can be accessed using `/quests admin migratedata`, which will generate a file [migrate_data.yml](https://github.com/LMBishop/Quests/blob/master/bukkit/src/main/resources/resources/bukkit/migrate_data.yml), -- cgit v1.2.3-70-g09d2