diff options
Diffstat (limited to 'bukkit/src/main')
6 files changed, 251 insertions, 182 deletions
diff --git a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminAboutCommandHandler.java b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminAboutCommandHandler.java index 5992b3f5..9dbecbee 100644 --- a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminAboutCommandHandler.java +++ b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminAboutCommandHandler.java @@ -21,7 +21,7 @@ public class AdminAboutCommandHandler implements CommandHandler { sender.sendMessage(ChatColor.RED + "Quests " + ChatColor.BOLD + "v" + plugin.getDescription().getVersion()); sender.sendMessage(ChatColor.DARK_GRAY + " - " + ChatColor.RED + "Source code: " + ChatColor.GRAY + "https://github.com/LMBishop/Quests/"); sender.sendMessage(ChatColor.DARK_GRAY + " - " + ChatColor.RED + "Report an issue: " + ChatColor.GRAY + "https://github.com/LMBishop/Quests/issues"); - sender.sendMessage(ChatColor.DARK_GRAY + " - " + ChatColor.RED + "Wiki: " + ChatColor.GRAY + "https://github.com/LMBishop/Quests/wiki"); + sender.sendMessage(ChatColor.DARK_GRAY + " - " + ChatColor.RED + "Documentation: " + ChatColor.GRAY + "https://quests.leonardobishop.com/"); sender.sendMessage(ChatColor.DARK_GRAY + " - " + ChatColor.RED + "Licensed under the GPLv3"); sender.sendMessage(ChatColor.GRAY + "Many contributors have written source code and task types for Quests," + " please see the GitHub link for an up-to-date list of contributors."); diff --git a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminWikiCommandHandler.java b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminWikiCommandHandler.java index b7c6ddf4..ced99de0 100644 --- a/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminWikiCommandHandler.java +++ b/bukkit/src/main/java/com/leonardobishop/quests/bukkit/command/AdminWikiCommandHandler.java @@ -18,7 +18,7 @@ public class AdminWikiCommandHandler implements CommandHandler { @Override public void handle(CommandSender sender, String[] args) { - sender.sendMessage(ChatColor.RED + "Link to Quests wiki: " + ChatColor.GRAY + "https://github.com/LMBishop/Quests/wiki"); + sender.sendMessage(ChatColor.RED + "Link to Quests documentation: " + ChatColor.GRAY + "https://quests.leonardobishop.com/"); } @Override diff --git a/bukkit/src/main/resources/resources/bukkit/categories.yml b/bukkit/src/main/resources/resources/bukkit/categories.yml index 0ca444ec..fdfee477 100644 --- a/bukkit/src/main/resources/resources/bukkit/categories.yml +++ b/bukkit/src/main/resources/resources/bukkit/categories.yml @@ -1,9 +1,14 @@ -# Categories are a way of grouping up quests. -# When a player uses /quests, a menu of categories will be presented to them. -# When a player clicks ona category, a list of quests under that category will show. -# If categories are disabled, all quests will be shown under one big GUI. -# Players can access specific categories by command using /quests c [category]. -# If a quest does not have a category, it will not be shown. +# ----------------------------------------------------------- +# Categories +# ---------- +# +# Categories are a way of grouping quests. +# When a player uses /quests, a menu of categories will be presented to them. +# When a player clicks on a category, a list of quests under that category will show. +# If categories are disabled, all quests will be shown under one big GUI. +# Players can access specific categories by command using /quests c [category]. +# If a quest does not have a category, it will not be shown. +# ----------------------------------------------------------- categories: examples: display: diff --git a/bukkit/src/main/resources/resources/bukkit/config.yml b/bukkit/src/main/resources/resources/bukkit/config.yml index ab6e0c18..4f77542a 100644 --- a/bukkit/src/main/resources/resources/bukkit/config.yml +++ b/bukkit/src/main/resources/resources/bukkit/config.yml @@ -1,148 +1,34 @@ -# | =================================================== | -# | Thank you for downloading and trying out | -# | Quests | -# | https://www.spigotmc.org/resources/23696/ | -# | https://github.com/LMBishop/Quests/ | -# | | -# | =x= | -# | | -# | Trying to add new quests? | -# | | -# | Go to the 'quests' | -# | subdirectory to edit the | -# | quests | -# | | -# | The example quests | -# | are commented to help you | -# | learn how to use the plugin | -# | | -# | =x= | -# | | -# | Have Discord & need help? | -# | Head to the GitHub page and click on the | -# | Discord link, or create an issue | -# | =================================================== | +# | ======================================================== | +# | | +# | [ Quests ] | +# | | +# | SpigotMC: https://www.spigotmc.org/resources/23696/ | +# | Source code: https://github.com/LMBishop/Quests/ | +# | Documentation: https://quests.leonardobishop.com/ | +# | | +# | =x= | +# | | +# | First time configuring Quests? | +# | | +# | Go to /plugins/Quests/quests to see example quests. | +# | | +# | =x= | +# | | +# | Have Discord and need help? | +# | | +# | Head to GitHub to get a Discord invite link, or open an | +# | issue. | +# | | +# | ======================================================== | -# Trying to add new categories? This has been moved to categories.yml - -# The items listed below are placeholder items for quests which the player cannot start. -# You should change these for 1.8 -gui: - back-button: - name: "&cReturn" - lore: - - "&7Return to the categories menu." - type: "ARROW" - page-prev: - name: "&7Previous Page" - lore: - - "&7Switch the page to page &c{prevpage}." - type: "FEATHER" - page-next: - name: "&7Next Page" - lore: - - "&7Switch the page to page &c{nextpage}." - type: "FEATHER" - page-desc: - name: "&7Page &c{page}" - lore: - - "&7You are currently viewing page &c{page}." - type: "PAPER" - quest-locked-display: - name: "&c&lQuest Locked" - lore: - - "&7You have not completed the requirements" - - "&7for this quest (&c{quest}&7)." - - "" - - "&7Requires: &c{requirements}" - - "&7to be completed to unlock." - type: "RED_STAINED_GLASS_PANE" - quest-permission-display: - name: "&6&lNo Permission" - lore: - - "&7You do not have permission for this" - - "&7quest (&6{quest}&7)." - type: "BROWN_STAINED_GLASS_PANE" - quest-cooldown-display: - name: "&e&lQuest On Cooldown" - lore: - - "&7You have recently completed this quest" - - "&7(&e{quest}&7) and you must" - - "&7wait another &e{time} &7to unlock again." - type: "ORANGE_STAINED_GLASS_PANE" - quest-completed-display: - name: "&a&lQuest Complete" - lore: - - "&7You have completed this quest" - - "&7(&a{quest}&7) and cannot." - - "&7repeat it." - type: "GREEN_STAINED_GLASS_PANE" - no-started-quests: - name: "&c&lNo Started Quests" - lore: - - "&7Go start some!" - type: "FEATHER" - quest-cancel-yes: - name: "&a&lConfirm Cancel" - lore: - - "&7Confirm you wish to cancel" - - "&7this quest and lose all" - - "&7progress." - type: "GREEN_STAINED_GLASS_PANE" - quest-cancel-no: - name: "&c&lAbort Cancel" - lore: - - "&7Return to the quest menu." - type: "RED_STAINED_GLASS_PANE" - quest-cancel-background: - type: "GRAY_STAINED_GLASS_PANE" - -# Here you can add custom items to the quest menu -# Categories & quests will fill empty slots -#custom-elements: -# "categories": # apply to the categories menu (the main menu by default) -# 0: # <--- slot 1, note the slots start from 0! so 0 = slot 1 in this case -# display: -# name: "&cExample Custom Item (slot 1)" -# lore: -# - "&7This is a custom item which can be added" -# - "&7to your menus. This is purely cosmetic." -# - "" -# - "&7Two empty slots should follow." -# type: "DIAMOND_BLOCK" -# 1: # <--- start from slot 2 -# spacer: true # empty slot in GUI -# repeat: 2 # repeats for 2 slots -# 3: # <--- start from slot 4 -# display: -# name: "&cExample Custom Item (slots 4 - 7)" -# lore: -# - "&7This is a custom item which can be added" -# - "&7to your menus, but in slot 4 and repeated" -# - "&73 times." -# - "&7" -# - "&7This will come after 2 empty slots." -# - "&7" -# - "&7This is purely cosmetic." -# type: "NETHERRACK" -# repeat: 3 # repeats for 3 more slots -# "c:examples": # apply to the category "examples" -# 0: -# display: -# name: "&cExample Custom Item (slot 1)" -# lore: -# - "&7This is a custom item which can be added" -# - "&7to your menus. This is purely cosmetic." -# type: "EMERALD_BLOCK" -# "quests": # apply to the general quests menu IF categories are disabled -# 0: -# display: -# name: "&cExample Custom Item (slot 1)" -# lore: -# - "&7This is a custom item which can be added" -# - "&7to your menus. This is purely cosmetic." -# type: "EMERALD_BLOCK" +# Trying to add new categories? This has been moved to the categories.yml file. +# ----------------------------------------------------------- +# Basic options +# ------------- +# +# Docs: https://quests.leonardobishop.com/configuration/basic-options.html +# ----------------------------------------------------------- options: # If categories are disabled, quests will be put into one big gui. categories-enabled: true @@ -171,7 +57,7 @@ options: quests-started-menu: "Started Quests" daily-quests: "Daily Quests" quest-cancel: "Cancel Quest" - # See https://github.com/LMBishop/Quests/wiki/Basic-Options#sounds + # See https://quests.leonardobishop.com/configuration/basic-options.html#sounds sounds: quest-start: "ENTITY_PLAYER_LEVELUP:2:3" quest-cancel: "UI_TOAST_OUT:2:3" @@ -202,7 +88,7 @@ options: quest-autostart: false # Automatically track quests on start, and stop tracking on completion quest-autotrack: true - # How much quests should log, 0 = errors only, 1 = warnings, 2 = info, 3 = debug + # How much Quests should log, 0 = errors only, 1 = warnings, 2 = info, 3 = debug verbose-logging-level: 2 # Record Quests log history for /q a debug record-log-history: true @@ -227,16 +113,16 @@ options: override-errors: false # How much time (in seconds) that plugin will cache placeholders placeholder-cache-time: 10 - # Whether or not the global task configuration will override per-task configuration settings + # Whether the global task configuration will override per-task configuration settings global-task-configuration-override: false - # Whether or not the global display configuration will override per-quest display settins + # Whether the global display configuration will override per-quest display settins global-quest-display-configuration-override: false - # Storage options - please see the following: https://github.com/LMBishop/Quests/wiki/Storage-Providers + # Storage options - please see the following: https://quests.leonardobishop.com/configuration/storage-providers.html storage: # Either 'yaml' (flatfile) or 'mysql' (network) - # Please read the following before using MySQL https://github.com/LMBishop/Quests/wiki/Storage-Providers#network + # Please read the following before using MySQL https://quests.leonardobishop.com/configuration/storage-providers.html#network provider: "yaml" - # See: https://github.com/LMBishop/Quests/wiki/Storage-Providers#Data-synchronisiation + # See: https://quests.leonardobishop.com/configuration/storage-providers.html#data-synchronisiation # https://github.com/LMBishop/Quests/issues/180 synchronisation: delay-loading: 0 # (ticks) @@ -262,22 +148,34 @@ options: # The prefix each table will use table-prefix: "quests_" - quest-mode: mode: "NORMAL" # More modes are a work in progress -# The global task configuration will apply to the config of each task of a specified type in each quest. -# In the example below, every task with a type of "inventory" will have the config option "update-progress" -# set to true. This is useful if you do not want to go through each quest if you want to update the configuration -# for every task of a specific type. + +# ----------------------------------------------------------- +# Global task configuration +# ------------------------- # -# You must uncomment all below lines for the example to have any effect -# vvvvvvvvvvvvvvvvvvvvvvvvv +# The global task configuration will apply to the config of each task of a specified type in each quest. +# In the example below, every task with a type of "inventory" will have the config option "update-progress" +# set to true. This is useful if you do not want to go through each quest if you want to update the configuration +# for every task of a specific type. +# +# Docs: https://quests.leonardobishop.com/configuration/global-configurations.html#global-task-configuration +# ----------------------------------------------------------- #global-task-configuration: # types: # inventory: # update-progress: true + +# ----------------------------------------------------------- +# Global quest display +# -------------------- +# +# The global quest display appends text to items in the GUI. +# Docs: https://quests.leonardobishop.com/configuration/global-configurations.html#global-quest-display-configuration +# ----------------------------------------------------------- global-quest-display: lore: # append-normal: @@ -296,13 +194,155 @@ global-quest-display: - "&eMiddle Click &7to stop tracking this quest." - "&eRight Click &7to cancel this quest." -# Macros for faster quests configuration without having to repeat -# yourself. -# See wiki for more information. + +# ----------------------------------------------------------- +# Macros +# ------ +# +# Macros for faster quests configuration without having to repeat yourself. +# Docs: https://quests.leonardobishop.com/configuration/global-configurations.html#global-macros +# ----------------------------------------------------------- global-macros: bar: "&6---&7---&6---" -# Configure titles + +# ----------------------------------------------------------- +# GUI configuration +# ----------------- +# +# The items listed below are placeholder items for quests which the player cannot start. +# You should change these for 1.8 +# Docs: https://quests.leonardobishop.com/configuration/gui-configuration.html +# ----------------------------------------------------------- +gui: + back-button: + name: "&cReturn" + lore: + - "&7Return to the categories menu." + type: "ARROW" + page-prev: + name: "&7Previous Page" + lore: + - "&7Switch the page to page &c{prevpage}." + type: "FEATHER" + page-next: + name: "&7Next Page" + lore: + - "&7Switch the page to page &c{nextpage}." + type: "FEATHER" + page-desc: + name: "&7Page &c{page}" + lore: + - "&7You are currently viewing page &c{page}." + type: "PAPER" + quest-locked-display: + name: "&c&lQuest Locked" + lore: + - "&7You have not completed the requirements" + - "&7for this quest (&c{quest}&7)." + - "" + - "&7Requires: &c{requirements}" + - "&7to be completed to unlock." + type: "RED_STAINED_GLASS_PANE" + quest-permission-display: + name: "&6&lNo Permission" + lore: + - "&7You do not have permission for this" + - "&7quest (&6{quest}&7)." + type: "BROWN_STAINED_GLASS_PANE" + quest-cooldown-display: + name: "&e&lQuest On Cooldown" + lore: + - "&7You have recently completed this quest" + - "&7(&e{quest}&7) and you must" + - "&7wait another &e{time} &7to unlock again." + type: "ORANGE_STAINED_GLASS_PANE" + quest-completed-display: + name: "&a&lQuest Complete" + lore: + - "&7You have completed this quest" + - "&7(&a{quest}&7) and cannot." + - "&7repeat it." + type: "GREEN_STAINED_GLASS_PANE" + no-started-quests: + name: "&c&lNo Started Quests" + lore: + - "&7Go start some!" + type: "FEATHER" + quest-cancel-yes: + name: "&a&lConfirm Cancel" + lore: + - "&7Confirm you wish to cancel" + - "&7this quest and lose all" + - "&7progress." + type: "GREEN_STAINED_GLASS_PANE" + quest-cancel-no: + name: "&c&lAbort Cancel" + lore: + - "&7Return to the quest menu." + type: "RED_STAINED_GLASS_PANE" + quest-cancel-background: + type: "GRAY_STAINED_GLASS_PANE" + + +# ----------------------------------------------------------- +# Custom GUI elements +# ------------------- +# +# Custom elements allow you to add custom items to quest GUIs. +# See this page for more info: https://quests.leonardobishop.com/configuration/custom-gui-items.html +# ----------------------------------------------------------- +#custom-elements: +# "categories": # apply to the categories menu (the main menu by default) +# 0: # <--- slot 1, note the slots start from 0! so 0 = slot 1 in this case +# display: +# name: "&cExample Custom Item (slot 1)" +# lore: +# - "&7This is a custom item which can be added" +# - "&7to your menus. This is purely cosmetic." +# - "" +# - "&7Two empty slots should follow." +# type: "DIAMOND_BLOCK" +# 1: # <--- start from slot 2 +# spacer: true # empty slot in GUI +# repeat: 2 # repeats for 2 slots +# 3: # <--- start from slot 4 +# display: +# name: "&cExample Custom Item (slots 4 - 7)" +# lore: +# - "&7This is a custom item which can be added" +# - "&7to your menus, but in slot 4 and repeated" +# - "&73 times." +# - "&7" +# - "&7This will come after 2 empty slots." +# - "&7" +# - "&7This is purely cosmetic." +# type: "NETHERRACK" +# repeat: 3 # repeats for 3 more slots +# "c:examples": # apply to the category "examples" +# 0: +# display: +# name: "&cExample Custom Item (slot 1)" +# lore: +# - "&7This is a custom item which can be added" +# - "&7to your menus. This is purely cosmetic." +# type: "EMERALD_BLOCK" +# "quests": # apply to the general quests menu IF categories are disabled +# 0: +# display: +# name: "&cExample Custom Item (slot 1)" +# lore: +# - "&7This is a custom item which can be added" +# - "&7to your menus. This is purely cosmetic." +# type: "EMERALD_BLOCK" + + +# ----------------------------------------------------------- +# Titles and messages +# ------------------- +# +# Please refer to the source code for the default messages. +# ----------------------------------------------------------- titles: quest-start: title: "&cQuest Started" @@ -311,7 +351,6 @@ titles: title: "&cQuest Complete" subtitle: "&7{quest}" -# Configure messages messages: time-format: "{hours}h {minutes}m" quest-start: "&7Quest &c{quest} &7started!" @@ -372,3 +411,11 @@ messages: placeholderapi-false: "false" placeholderapi-no-tracked-quest: "No tracked quest" placeholderapi-data-not-loaded: "Data not loaded" + + +# ----------------------------------------------------------- +# There are more configuration options available. +# Please see the documentation for all available options. +# +# https://quests.leonardobishop.com/ +# ----------------------------------------------------------- diff --git a/bukkit/src/main/resources/resources/bukkit/migrate_data.yml b/bukkit/src/main/resources/resources/bukkit/migrate_data.yml index 0c392072..fc75659f 100644 --- a/bukkit/src/main/resources/resources/bukkit/migrate_data.yml +++ b/bukkit/src/main/resources/resources/bukkit/migrate_data.yml @@ -1,3 +1,6 @@ +# Data migration tool +# ------------------- +# # This file was automatically generated by the Quests data migration tool (/q a migratedata). # Please read these instructions carefully. # @@ -24,7 +27,7 @@ # configuration file to point to the new storage provider manually. # # These instructions are also available on the wiki: -# https://github.com/LMBishop/Quests/wiki/Data-migration-tool +# https://quests.leonardobishop.com/tools/data-migration-tool.html # Data provider to migrate from from: diff --git a/bukkit/src/main/resources/resources/bukkit/quests/README.txt b/bukkit/src/main/resources/resources/bukkit/quests/README.txt index 779dd6bb..1fce92f6 100644 --- a/bukkit/src/main/resources/resources/bukkit/quests/README.txt +++ b/bukkit/src/main/resources/resources/bukkit/quests/README.txt @@ -1,21 +1,33 @@ -# !! READ ME - IT WILL NOT TAKE LONG !! +# +# Documentation +# ------------- +# +# The parameters a quest can have is documented on the wiki. +# https://quests.leonardobishop.com/configuration/creating-a-quest.html +# +# +# How to create a quest +# --------------------- # # Each file ín the 'quests' folder defines a single quest. # The name of the file is the quest ID. These must be alphanumeric and unique. # Quest files must be in the .yml format. # -# A quest is a series of tasks which players must complete for a reward and may require a previous quest to start. +# A quest is a series of tasks which players must complete for a reward and may require a +# previous quest to start. # A task is an objective such as breaking blocks or obtaining items. # A reward is a command executed by the SERVER. Use {player} to get the players name. # -# Most task types will allow you to restrict them to a certain world. Check out the wiki for which ones. +# Most task types will allow you to restrict them to a certain world. Check the wiki for which ones. # -# A quest can have a 'startstring' (this is optional). They will be sent to the player when they start the quest. -# A quest can have a 'rewardstring' (this is optional). They will be sent to the player when they complete the quest. +# A quest can have a 'startstring' (optional). +# - This will be sent to the player when they start the quest. +# A quest can have a 'rewardstring' (optional). +# - This will be sent to the player when they complete the quest. # An example of the startstring/rewardstring in use can be seen in the quest example4. # # Each quest will have ONE "display" item, this is the item shown to the player in the GUI. -# The display item will have a "name", a "type" and TWO lores. +# The display item will have a "name", a "type" and TWO lores (descriptions). # The name is the name of the item, the type is the material and the lore is the text underneath the item (when mouse-over-ing). # The first lore you must give is called 'lore-normal'. This is the lore seen if the player has not started the quest. # The second lore you must give is 'lore-started'. This will be APPENDED to the first lore IF the player has started the quest - useful for putting progression. @@ -25,16 +37,18 @@ # Quests can be put inside a category. When a player runs /quests they will first see a menu of categories. # They can click one and another menu of quests under that category will show up. # -# =============================================================== +# +# Task types +# ---------- # # You can see other task types here: -# https://github.com/LMBishop/Quests/wiki/Task-Types +# https://quests.leonardobishop.com/task-types/ # -# =============================================================== # # Need help? +# ---------- +# # Find the Discord link in the README.md, or open an issue on GitHub # https://github.com/LMBishop/Quests/issues # https://github.com/LMBishop/Quests/blob/master/README.md -# -# =============================================================== +#
\ No newline at end of file |