Quest tracking

8 files changed, 76 insertions, 30 deletions

diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
index 0d6e8fa5..7379458d 100644
--- a/src/main/resources/config.yml
+++ b/src/main/resources/config.yml
@@ -137,7 +137,7 @@ options:
   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
+  # Allow players to cancel a quest (you may want to remove the cancel instructions in the global item lore)
   allow-quest-cancel: true
   # Titles for the GUIs
   guinames:
@@ -155,6 +155,8 @@ options:
   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
   # Automatically clean player's quest progress files when they join.
@@ -202,6 +204,23 @@ daily-quests:
 #    inventory:
 #      update-progress: true
 
+global-quest-display:
+  lore:
+    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:
@@ -217,6 +236,8 @@ messages:
   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-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."
diff --git a/src/main/resources/quests/example1.yml b/src/main/resources/quests/example1.yml
index d0d44203..ca57f714 100644
--- a/src/main/resources/quests/example1.yml
+++ b/src/main/resources/quests/example1.yml
@@ -21,16 +21,16 @@ display:
     - "&cattributes a quest can have."
     - ""
     - "&7This quest requires you to:"
-    - "&7 - Break 30 blocks."
+    - "&7 - Break &f30 blocks&7."
     - ""
     - "&7Rewards:"
-    - "&7 - 10 diamonds."
+    - "&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 - {mining:progress}/30 blocks broken."
+    - "&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"
 
@@ -38,6 +38,13 @@ display:
 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.
diff --git a/src/main/resources/quests/example2.yml b/src/main/resources/quests/example2.yml
index 1ed6c0e1..7ad82bea 100644
--- a/src/main/resources/quests/example2.yml
+++ b/src/main/resources/quests/example2.yml
@@ -16,21 +16,24 @@ display:
     - "&cmultiple things to be done, unlike the previous one."
     - ""
     - "&7This quest requires you to:"
-    - "&7 - Break 100 blocks."
-    - "&7 - Place 100 blocks."
+    - "&7 - Break &f100 &7blocks."
+    - "&7 - Place &f100 &7blocks."
     - ""
     - "&7Rewards:"
-    - "&7 - 15 diamonds."
-    - "&7 - $50 added to your in-game balance."
+    - "&7 - &f15 diamonds&7."
+    - "&7 - &f$50&7 added to your in-game balance."
   lore-started:
     - ""
     - "&7Your current progression:"
-    - "&7 - {mining:progress}/100 blocks broken."
-    - "&7 - {building:progress}/100 blocks placed."
+    - "&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.
diff --git a/src/main/resources/quests/example3.yml b/src/main/resources/quests/example3.yml
index 29e4f91a..dbd893e4 100644
--- a/src/main/resources/quests/example3.yml
+++ b/src/main/resources/quests/example3.yml
@@ -19,21 +19,24 @@ display:
     - "&cafter a cooldown, unlike the previous one."
     - ""
     - "&7This quest requires you to:"
-    - "&7 - Break 81 gold ore."
-    - "&7 - Place 9 gold blocks."
+    - "&7 - Break &f81 gold ore&7."
+    - "&7 - Place &f9 gold blocks&7."
     - ""
     - "&7Rewards:"
-    - "&7 - 30 diamonds."
-    - "&7 - $10 added to your in-game balance."
+    - "&7 - &f30 diamonds&7."
+    - "&7 - &f$10&7 added to your in-game balance."
   lore-started:
     - ""
     - "&7Your current progression:"
-    - "&7 - {mining:progress}/81 gold ore broken."
-    - "&7 - {building:progress}/9 gold blocks placed."
+    - "&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:
diff --git a/src/main/resources/quests/example4.yml b/src/main/resources/quests/example4.yml
index 28734ae7..4e9c27a8 100644
--- a/src/main/resources/quests/example4.yml
+++ b/src/main/resources/quests/example4.yml
@@ -14,15 +14,15 @@ display:
     - "&cunlike the previous one."
     - ""
     - "&7This quest requires you to:"
-    - "&7 - Kill 3 mobs."
+    - "&7 - Kill &f3 &7mobs."
     - ""
     - "&7Rewards:"
-    - "&7 - $50 added to your in-game balance."
-    - "&7 - 1 diamond ."
+    - "&7 - &f$50 &7added to your in-game balance."
+    - "&7 - &f1 diamond&7."
   lore-started:
     - ""
     - "&7Your current progression:"
-    - "&7 - {mobkilling:progress}/3 mobs killed."
+    - "&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:
@@ -32,6 +32,9 @@ startstring:
 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."
diff --git a/src/main/resources/quests/example5.yml b/src/main/resources/quests/example5.yml
index bfdc8d94..cb92f0f1 100644
--- a/src/main/resources/quests/example5.yml
+++ b/src/main/resources/quests/example5.yml
@@ -10,17 +10,20 @@ display:
     - "&ccertain permissions."
     - ""
     - "&7This quest requires you to:"
-    - "&7 - Place 10 blocks."
+    - "&7 - Place &f10 &7blocks."
     - ""
     - "&7Rewards:"
-    - "&7 - $10 added to your in-game balance."
+    - "&7 - &f$10 &7added to your in-game balance."
   lore-started:
     - ""
     - "&7Your current progression:"
-    - "&7 - {building:progress}/10 blocks placed."
+    - "&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:
diff --git a/src/main/resources/quests/example6.yml b/src/main/resources/quests/example6.yml
index abadba2a..0913a7cb 100644
--- a/src/main/resources/quests/example6.yml
+++ b/src/main/resources/quests/example6.yml
@@ -10,17 +10,20 @@ display:
     - "&ccertain permissions."
     - ""
     - "&7This quest requires you to:"
-    - "&7 - Place 10 blocks."
+    - "&7 - Place &f10 &7blocks."
     - ""
     - "&7Rewards:"
-    - "&7 - $10 added to your in-game balance."
+    - "&7 - &f$10 &7added to your in-game balance."
   lore-started:
     - ""
     - "&7Your current progression:"
-    - "&7 - {building:progress}/10 blocks placed."
+    - "&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"
diff --git a/src/main/resources/quests/example7.yml b/src/main/resources/quests/example7.yml
index 96bbb376..32bb7e04 100644
--- a/src/main/resources/quests/example7.yml
+++ b/src/main/resources/quests/example7.yml
@@ -5,24 +5,27 @@ tasks:
     worlds:
       - "world"
 display:
-  name: "&cExample VI (Different category, world restricted)"
+  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 10 blocks."
+    - "&7 - Place &f10 &7blocks."
     - ""
     - "&7Rewards:"
-    - "&7 - $10 added to your in-game balance."
+    - "&7 - &f$10 &7added to your in-game balance."
   lore-started:
     - ""
     - "&7Your current progression:"
-    - "&7 - {building:progress}/10 blocks placed."
+    - "&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"