aboutsummaryrefslogtreecommitdiffstats
path: root/bukkit/src/main/resources
diff options
context:
space:
mode:
Diffstat (limited to 'bukkit/src/main/resources')
-rw-r--r--bukkit/src/main/resources/plugin.yml30
-rw-r--r--bukkit/src/main/resources/resources/bukkit/config.yml355
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/README.txt40
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example1.yml61
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example2.yml47
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example3.yml49
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example4.yml50
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example5.yml38
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example6.yml35
-rw-r--r--bukkit/src/main/resources/resources/bukkit/quests/example7.yml37
10 files changed, 742 insertions, 0 deletions
diff --git a/bukkit/src/main/resources/plugin.yml b/bukkit/src/main/resources/plugin.yml
new file mode 100644
index 00000000..5cb81473
--- /dev/null
+++ b/bukkit/src/main/resources/plugin.yml
@@ -0,0 +1,30 @@
+name: Quests
+
+# This will be replaced with the property "version" in build.gradle
+version: ${version}
+
+main: com.leonardobishop.quests.bukkit.BukkitQuestsPlugin
+website: https://github.com/LMBishop/Quests
+author: "LMBishop & contributors"
+softdepend: [ASkyBlock, BentoBox, IridiumSkyblock, uSkyBlock, Citizens, MythicMobs, PlaceholderAPI, Essentials, ShopGUIPlus, CoreProtect]
+prefix: Quests
+api-version: "1.13" # allows new API features but Quests will still work pre-1.13
+
+commands:
+ quests:
+ description: Interact with your quests
+ usage: /quests
+ permission: quests.command
+ aliases: [q, quest]
+
+#todo redo perms
+permissions:
+ quests.command:
+ description: Permission for main command
+ default: true
+ quests.command.random:
+ description: Permission to execute /q random
+ default: true
+ quests.admin:
+ description: Permission for the admin commands
+ default: op \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/config.yml b/bukkit/src/main/resources/resources/bukkit/config.yml
new file mode 100644
index 00000000..f7084505
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/config.yml
@@ -0,0 +1,355 @@
+# | =================================================== |
+# | 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 |
+# | =================================================== |
+
+
+# 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:
+ examples:
+ display:
+ name: "&cExample Quests"
+ lore:
+ - "&7This category contains example quests"
+ - "&7which are commented in the config."
+ - "&7The comments should guide you with"
+ - "&7how the config works."
+ - ""
+ - "&cIt is highly recommended you read this"
+ - "&csection and all the comments so you can"
+ - "&cmake the most of this plugin."
+ type: "WATER_BUCKET"
+ permissionexample:
+ display:
+ name: "&cPermission Example"
+ lore:
+ - "&7This category is an example of one which"
+ - "&7requires a permission to open."
+ - ""
+ - "&cIt is highly recommended you read this"
+ - "&csection and all the comments so you can"
+ - "&cmake the most of this plugin."
+ type: "WATER_BUCKET"
+ # This category needs the permission "quests.category.permissionexample", because the category ID is 'permissionexample'.
+ # The permission for other categories is: "quests.category.<id>".
+ permission-required: true
+
+# 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"
+
+options:
+ # If categories are disabled, quests will be put into one big gui.
+ categories-enabled: true
+ # If true, the gui size will automatically change based on the amount of quests inside it.
+ trim-gui-size: true
+ # Enable/disable titles
+ titles-enabled: true
+ # Players cannot start any more quests than this at a single time
+ quest-started-limit: 2
+ # Hide locked quests, quests on cooldown and completed (but not repeatable) quests
+ gui-hide-locked: false
+ # Allow players to cancel a quest (you may want to remove the cancel instructions in the global item lore)
+ allow-quest-cancel: true
+ # Allow players to track a quest (you may want to remove the tracking instructions in the global item lore)
+ allow-quest-track: true
+ # Titles for the GUIs
+ guinames:
+ quests-category: "Quests Categories"
+ quests-menu: "Quests"
+ quests-started-menu: "Started Quests"
+ daily-quests: "Daily Quests"
+ quest-cancel: "Cancel Quest"
+ # Show when quests register in console - will only show if verbose-logging-level=2. Disable if you want less console spam at startup.
+ show-quest-registrations: true
+ # Hide quests which a player cannot start due to permissions.
+ gui-hide-quests-nopermission: false
+ # Hide categories which a player cannot open due to permissions.
+ gui-hide-categories-nopermission: false
+ # Replace placeholders from PlaceholderAPI in Quests GUI items
+ gui-use-placeholderapi: false
+ # Make it so players do not have to start quest themselves
+ 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
+ verbose-logging-level: 2
+ # Verify quests exist when a player's data is loaded - inconsistencies may arise when
+ # players progress on specific quests and those quests are later removed. The problem is that their progress
+ # is still kept in the quest progress file, which may lead to issues such as players reaching a quest started
+ # limit when the quests they had active no longer exist - having this option enabled prevents
+ # non-existent quests from being loaded
+ verify-quest-exists-on-load: true
+ performance-tweaking: # The following are measured in server ticks, multiply SECONDS by 20 to get the number of ticks.
+ quest-queue-executor-interval: 1 # how frequently Quests should execute the next check in the completion queue (def=1 - 0.05s) - increase this value if you are struggling with performance
+ quest-autosave-interval: 12000 # how frequently online players data will be autosaved (def=12000 - 10 minutes)
+ tab-completion:
+ enabled: true
+ error-checking:
+ # Allow quests to be loaded if they contain errors
+ # This may lead to errors in the console!
+ 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
+ global-task-configuration-override: false
+ # Whether or not 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:
+ # Either 'yaml' (flatfile) or 'mysql' (network)
+ # Please read the following before using MySQL https://github.com/LMBishop/Quests/wiki/Storage-Providers#network
+ provider: "yaml"
+ # The following is only applicable for database storage providers (e.g. mysql)
+ database-settings:
+ network:
+ # The name of the database. This database should already exist!
+ database: "minecraft"
+ username: "root"
+ password: ""
+ # Address should be in the format ip:port (just like the game itself)
+ address: "localhost:3306"
+ # This plugin uses 'HikariCP' for connection management, the pooling configuration can be changed here
+ connection-pool-settings:
+ # The maximum number of connections to keep open with the database (def=8)
+ maximum-pool-size: 8
+ # The minimum number of connections to keep open with the database (def=8)
+ minimum-idle: 8
+ # The maximum time (in milliseconds) to keep a single connection open (def=1800000 - 30 min)
+ maximum-lifetime: 1800000
+ # The time (in milliseconds) the plugin will wait for a response by the database (def=500)
+ connection-timeout: 5000
+ # 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.
+#
+# You must uncomment all below lines for the example to have any effect
+# vvvvvvvvvvvvvvvvvvvvvvvvv
+#global-task-configuration:
+# types:
+# inventory:
+# update-progress: true
+
+global-quest-display:
+ lore:
+# append-normal:
+# - "..."
+ append-not-started:
+ - ""
+ - "&eLeft Click &7to start this quest."
+ append-started:
+ - ""
+ - "&aYou have started this quest."
+ - "&eMiddle Click &7to track this quest."
+ - "&eRight Click &7to cancel this quest."
+ append-tracked:
+ - ""
+ - "&aYou are &etracking &athis quest."
+ - "&eMiddle Click &7to stop tracking this quest."
+ - "&eRight Click &7to cancel this quest."
+
+
+# Configure titles
+titles:
+ quest-start:
+ title: "&cQuest Started"
+ subtitle: "&7{quest}"
+ quest-complete:
+ title: "&cQuest Complete"
+ subtitle: "&7{quest}"
+
+# Configure messages
+messages:
+ time-format: "{hours}h {minutes}m"
+ quest-start: "&7Quest &c{quest} &7started!"
+ quest-complete: "&7Quest &c{quest} &7completed!"
+ quest-cancel: "&7Quest &c{quest} &7cancelled!"
+ quest-track: "&7Tracking quest &c{quest}&7."
+ quest-track-stop: "&7No longer tracking quest &c{quest}&7."
+ quest-random-none: "&cYou have no quests which you can start."
+ quest-start-limit: "&7Players are limited to &c{limit} &7started quests at a time."
+ quest-start-disabled: "&7You cannot repeat this quest."
+ quest-start-locked: "&7You have not unlocked this quest yet."
+ quest-start-cooldown: "&7You have recently completed this quest. You have to wait &c{time} &7until you are able to restart it."
+ quest-start-started: "&7You have already started this quest."
+ quest-start-permission: "&7You do not have permission to start this quest."
+ quest-category-permission: "&7You do not have permission to view this category."
+ quest-category-quest-permission: "&7You do not have permission to start this quest since it is in a category you do not have permission to view."
+ quest-cancel-notstarted: "&7You have not started this quest."
+ quest-updater: "&cQuests > &7A new version &c{newver} &7was found on Spigot (your version: &c{oldver}&7). Please update me! <3 - Link: {link}"
+ command-data-not-loaded: "&4Your quests progress file has not been loaded; you cannot use quests. If this issue persists, contact an admin."
+ command-sub-doesntexist: "&7The specified subcommand '&c{sub}' &7does not exist."
+ command-quest-start-doesntexist: "&7The specified quest '&c{quest}&7' does not exist."
+ command-quest-general-doesntexist: "&7The specified quest '&c{quest}&7' does not exist."
+ command-category-open-disabled: "&7Categories are disabled."
+ command-category-open-doesntexist: "&7The specified category '&c{category}&7' does not exist."
+ command-quest-admin-playernotfound: "&7Player '&c{player}&7' could not be found."
+ command-quest-openquests-admin-success: "&7Opened Quest GUI for player &c{player}&7."
+ command-quest-opencategory-admin-success: "&7Opened category &c{category} &7for player &c{player}&7."
+ command-taskview-admin-fail: "&7Task type '&c{task}&7' does not exist."
+ beta-reminder: "&cQuests > &7Reminder: you are currently using a &cbeta &7version of Quests. Please send bug reports to https://github.com/fatpigsarefat/Quests/issues and check for updates regularly using &c/quests admin update&7!"
+ command-quest-admin-loaddata: "&7Quest data for '&c{player}&7' is being loaded."
+ command-quest-admin-nodata: "&7No data could be found for player &c{player}&7."
+ command-quest-admin-fullreset: "&7Data for player &c{player}&7 has been fully reset."
+ command-quest-admin-clean-success: "&7All quest progress files have been cleaned."
+ command-quest-admin-clean-fail: "&cFailed to clean quest progress files. Please report the error in the console."
+ command-quest-admin-start-faillocked: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They have not yet unlocked it."
+ command-quest-admin-start-failcooldown: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. It is still on cooldown for them."
+ command-quest-admin-start-failcomplete: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They have already completed it."
+ command-quest-admin-start-faillimit: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They have reached their quest start limit."
+ command-quest-admin-start-failstarted: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. It is already started."
+ command-quest-admin-start-failpermission: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They do not have permission."
+ command-quest-admin-start-failcategorypermission: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7. They do not have permission for the category which the quest is in."
+ command-quest-admin-start-failother: "&7Quest '&c{quest}&7' could not be started for player &c{player}&7."
+ command-quest-admin-start-success: "&7Quest &c{quest} &7started for player &c{player}&7."
+ command-quest-admin-category-permission: "&7Category &c{category} &7 could not be opened for player &c{player}&7. They do not have permission to view it."
+ command-quest-admin-complete-success: "&7Quest &c{quest} &7completed for player &c{player}&7."
+ command-quest-admin-reset-success: "&7Successfully reset quest '&c{quest}&7' for player &c{player}&7."
+
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/README.txt b/bukkit/src/main/resources/resources/bukkit/quests/README.txt
new file mode 100644
index 00000000..779dd6bb
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/README.txt
@@ -0,0 +1,40 @@
+# !! READ ME - IT WILL NOT TAKE LONG !!
+#
+# 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 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.
+#
+# 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.
+# 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 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.
+# Within the lores you can get the players progress for each task. Use {TASKID:progress} (replace TASKID with the ID of the task).
+# You can also get if a task is complete. Use {TASKID:complete} (replace TASKID with the ID of the task).
+#
+# 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.
+#
+# ===============================================================
+#
+# You can see other task types here:
+# https://github.com/LMBishop/Quests/wiki/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
+#
+# ===============================================================
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example1.yml b/bukkit/src/main/resources/resources/bukkit/quests/example1.yml
new file mode 100644
index 00000000..ca57f714
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example1.yml
@@ -0,0 +1,61 @@
+# The name of this file is the quest ID. It must be alphanumeric and unique.
+
+# Everything inside of this section defines tasks the player must complete to progress.
+tasks:
+ # This is the task ID ("mining"). This can share the same name as the quest ID but MUST be unique with all other task IDs in the same quest.
+ mining:
+ # This defines what type of task this is. In this instance, it is "blockbreak" (breaking blocks)
+ # NOTE: guides to set up each type of task is on the wiki (see README)!
+ type: "blockbreak"
+ # This defines the amount of blocks which need to be broken
+ amount: 30
+ # You can have multiple tasks for each quest (example further down).
+
+# Everything inside of this section defines the display item.
+display:
+ # This is the name of the item. This allows color codes.
+ name: "&cExample I (Single Task)"
+ # This is the lore of the item if the player has not started the quest. This allows color codes and task/player placeholders.
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Break &f30 blocks&7."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f10 &7diamonds."
+ # This lore will be appended to the bottom of the above lore when the player starts their quest.
+ # To get the players progress through a task, use {TASKID:progress} and replace TASKID with the ID of the task.
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{mining:progress}&7/30 blocks broken."
+ # This is the material of the item. It is recommended to stick to bukkit names.
+ type: "WOODEN_PICKAXE"
+
+# List all commands to be executed by the server when the player completes the quest. Use {player} to get the players name.
+rewards:
+ - "give {player} diamond 10"
+
+# These placeholders are accessible using PlaceholderAPI, for example %quests_tracked_p:description%
+# They are useful for putting information about the players tracked quest on a scoreboard
+# You may want to keep the names of them the same for ALL quests for this use-case
+placeholders:
+ description: "&7Break &f30 blocks &7of any type."
+ progress: " &8- &f{mining:progress}&7/30 broken"
+
+# Everything inside this section define quest-specific options
+options:
+ # This is the category for the quest, it will appear under the "examples" category. Categories can be disabled.
+ category: "examples"
+ # Set if the quest can be repeated after being completed for the first time.
+ repeatable: false
+ # Define the cooldown on quests. The above (repeatable) must be true for this to take effect.
+ cooldown:
+ # If true, players will have to wait between repeating quests.
+ enabled: true
+ # Time (in minutes)
+ time: 1440
+ # This is the relative position in the GUI
+ sort-order: 1 \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example2.yml b/bukkit/src/main/resources/resources/bukkit/quests/example2.yml
new file mode 100644
index 00000000..7ad82bea
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example2.yml
@@ -0,0 +1,47 @@
+# This is a quest which requires the previous quest to be complete to start.
+
+tasks:
+ # Unlike the previous quest, this quest has multiple tasks.
+ mining:
+ type: "blockbreak"
+ amount: 100
+ building:
+ type: "blockplace"
+ amount: 100
+display:
+ name: "&cExample II (Multiple Tasks)"
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have. This quest requires"
+ - "&cmultiple things to be done, unlike the previous one."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Break &f100 &7blocks."
+ - "&7 - Place &f100 &7blocks."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f15 diamonds&7."
+ - "&7 - &f$50&7 added to your in-game balance."
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{mining:progress}&7/100 blocks broken."
+ - "&7 - &f{building:progress}&7/100 blocks placed."
+ type: "GRASS_BLOCK"
+rewards:
+ - "give {player} diamond 15"
+ - "eco give {player} 50"
+placeholders:
+ description: "&7Break and place &f100 blocks &7of any type."
+ progress: " &8- &f{mining:progress}&7/100 broken, &f{building:progress}&7/100 placed"
+options:
+ category: "examples"
+ # Unlike the previous quest, this quest has "example1" as a required quest. You cannot start this quest without "example1" quest complete.
+ requires:
+ - "example1"
+ repeatable: false
+ cooldown:
+ enabled: true
+ time: 1440
+ # The sort order has been changed so this quest will appear after in the GUI
+ sort-order: 2 \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example3.yml b/bukkit/src/main/resources/resources/bukkit/quests/example3.yml
new file mode 100644
index 00000000..dbd893e4
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example3.yml
@@ -0,0 +1,49 @@
+# This is a quest which requires the previous quest to be complete to start.
+# Unlike the previous quest, this one can be re-done but it has a 10 minute cooldown.
+
+tasks:
+ # Unlike the previous two quests, this quest specifies a specific block to be broken.
+ mining:
+ type: "blockbreakcertain"
+ amount: 81
+ block: GOLD_ORE
+ building:
+ type: "blockplacecertain"
+ amount: 9
+ block: GOLD_BLOCK
+display:
+ name: "&cExample III (Repeatable, 10 minute cooldown)"
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have. This quest can be replayed"
+ - "&cafter a cooldown, unlike the previous one."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Break &f81 gold ore&7."
+ - "&7 - Place &f9 gold blocks&7."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f30 diamonds&7."
+ - "&7 - &f$10&7 added to your in-game balance."
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{mining:progress}&7/81 gold ore broken."
+ - "&7 - &f{building:progress}&7/9 gold blocks placed."
+ type: "GOLD_ORE"
+rewards:
+ - "give {player} diamond 30"
+ - "eco give {player} 10"
+placeholders:
+ description: "&7Break &f81 gold ore &7and place &f9 gold blocks."
+ progress: " &8- &f{mining:progress}&7/81 gold ore, &f{building:progress}&7/9 gold blocks"
+options:
+ category: "examples"
+ requires:
+ - "example2"
+ # This quest is repeatable, it has cooldowns enabled (meaning the player must wait before repeating it) and the time set to 10 (minutes).
+ repeatable: true
+ cooldown:
+ enabled: true
+ time: 10
+ sort-order: 3 \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example4.yml b/bukkit/src/main/resources/resources/bukkit/quests/example4.yml
new file mode 100644
index 00000000..4e9c27a8
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example4.yml
@@ -0,0 +1,50 @@
+# This is a quest which requires the previous quest to be complete to start.
+# Unlike the previous quests, this quest has a reward string and a start string.
+
+tasks:
+ mobkilling:
+ type: "mobkilling"
+ amount: 3
+display:
+ name: "&cExample IV (Reward String)"
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have. This quest has a 'reward string'"
+ - "&c(a series of messages sent when a quest is complete),"
+ - "&cunlike the previous one."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Kill &f3 &7mobs."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f$50 &7added to your in-game balance."
+ - "&7 - &f1 diamond&7."
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{mobkilling:progress}&7/3 mobs killed."
+ type: "STRING"
+# Here you can list messages which will be sent to the player (if they are online) upon the quest starting.
+startstring:
+ - "&7Upon completion of this quest, you will be rewarded with"
+ - " &8* &c$50"
+ - " &8* &c1 diamonds"
+rewards:
+ - "eco give {player} 50"
+ - "give {player} diamond 1"
+placeholders:
+ description: "&7Kill &f3 &7mobs."
+ progress: " &8- &f{mobkilling:progress}&7/3 mobs"
+# Here you can list messages which will be sent to the player (if they are online) upon completion.
+rewardstring:
+ - " &8* &c$1000 &7was added to your in-game balance."
+ - " &8* &c1 diamond &7was added to your inventory."
+options:
+ category: "examples"
+ requires:
+ - "example3"
+ repeatable: true
+ cooldown:
+ enabled: true
+ time: 10
+ sort-order: 4 \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example5.yml b/bukkit/src/main/resources/resources/bukkit/quests/example5.yml
new file mode 100644
index 00000000..cb92f0f1
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example5.yml
@@ -0,0 +1,38 @@
+tasks:
+ building:
+ type: "blockplace"
+ amount: 10
+display:
+ name: "&cExample V (Permission)"
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have. This quest requires"
+ - "&ccertain permissions."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Place &f10 &7blocks."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f$10 &7added to your in-game balance."
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{building:progress}&7/10 blocks placed."
+ type: "GRASS_BLOCK"
+rewards:
+ - "eco give {player} 10"
+placeholders:
+ description: "&7Place &f10 &7blocks of any type."
+ progress: " &8- &f{building:progress}&7/10 blocks"
+options:
+ category: "examples"
+ requires:
+ - "example4"
+ # Unlike the previous quests, this one requires you to have the permission "quests.quest.example5" to start.
+ # The permission for other quests is: "quests.quest.<id>".
+ permission-required: true
+ repeatable: false
+ cooldown:
+ enabled: true
+ time: 1440
+ sort-order: 5 \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example6.yml b/bukkit/src/main/resources/resources/bukkit/quests/example6.yml
new file mode 100644
index 00000000..0913a7cb
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example6.yml
@@ -0,0 +1,35 @@
+tasks:
+ building:
+ type: "blockplace"
+ amount: 10
+display:
+ name: "&cExample VI (Different category, permissions)"
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have. This quest requires"
+ - "&ccertain permissions."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Place &f10 &7blocks."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f$10 &7added to your in-game balance."
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{building:progress}&7/10 blocks placed."
+ type: "GRASS_BLOCK"
+rewards:
+ - "eco give {player} 10"
+placeholders:
+ description: "&7Place &f10 &7blocks of any type."
+ progress: " &8- &f{building:progress}&7/10 blocks"
+options:
+ category: "permissionexample"
+ # This quest has no specific permission, however its category does. The permission for the category is "quests.category.permissionexample"
+ repeatable: false
+ cooldown:
+ enabled: true
+ time: 1440
+ # The quest is in a different category so the sort order is 1.
+ sort-order: 1 \ No newline at end of file
diff --git a/bukkit/src/main/resources/resources/bukkit/quests/example7.yml b/bukkit/src/main/resources/resources/bukkit/quests/example7.yml
new file mode 100644
index 00000000..32bb7e04
--- /dev/null
+++ b/bukkit/src/main/resources/resources/bukkit/quests/example7.yml
@@ -0,0 +1,37 @@
+tasks:
+ building:
+ type: "blockplace"
+ amount: 10
+ worlds:
+ - "world"
+display:
+ name: "&cExample VII (Different category, world restricted)"
+ lore-normal:
+ - "&cThis category is designed to show you the different"
+ - "&cattributes a quest can have. This quest requires"
+ - "&chas a task which requires you to be in a world called 'world'."
+ - ""
+ - "&7This quest requires you to:"
+ - "&7 - Place &f10 &7blocks."
+ - ""
+ - "&7Rewards:"
+ - "&7 - &f$10 &7added to your in-game balance."
+ lore-started:
+ - ""
+ - "&7Your current progression:"
+ - "&7 - &f{building:progress}&7/10 blocks placed."
+ type: "GRASS_BLOCK"
+rewards:
+ - "eco give {player} 10"
+placeholders:
+ description: "&7Place &f10 &7blocks of any type in world &fworld."
+ progress: " &8- &f{building:progress}&7/10 blocks"
+options:
+ category: "permissionexample"
+ # This quest has no specific permission, however its category does. The permission for the category is "quests.category.permissionexample"
+ repeatable: false
+ cooldown:
+ enabled: true
+ time: 1440
+ # The quest is in a different category so the sort order is 1.
+ sort-order: 1 \ No newline at end of file