Wrote new examples and updated config and pom.xml

4 files changed, 60 insertions, 10 deletions

diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
index 47c4d069..8edf1f7d 100644
--- a/src/main/resources/config.yml
+++ b/src/main/resources/config.yml
@@ -1,22 +1,29 @@
 # | =================================================== |
-# | Thank you for downloading and trying out my plugin: |
+# |      Thank you for downloading and trying out       |
 # |                       Quests                        |
 # |      https://www.spigotmc.org/resources/23696/      |
 # |         https://github.com/LMBishop/Quests/         |
 # |                                                     |
 # |                         =x=                         |
 # |                                                     |
-# |              File comments should help              |
-# |               you with the new config               |
-# |              and guide you with making              |
+# |              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?              |
-# |           https://www.discord.gg/8amrJnX            |
+# |       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.
diff --git a/src/main/resources/quests/README.txt b/src/main/resources/quests/README.txt
index 9a607a6d..779dd6bb 100644
--- a/src/main/resources/quests/README.txt
+++ b/src/main/resources/quests/README.txt
@@ -8,6 +8,8 @@
 # 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.
@@ -16,12 +18,12 @@
 # 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).
+# 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 does /quests they will first see a menu of categories. They can click one and another menu of quests
-# under that category will show up. Categories can be disabled.
+# 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.
 #
 # ===============================================================
 #
@@ -29,3 +31,10 @@
 # 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/src/main/resources/quests/example1.yml b/src/main/resources/quests/example1.yml
index eb6b865a..08402106 100644
--- a/src/main/resources/quests/example1.yml
+++ b/src/main/resources/quests/example1.yml
@@ -5,7 +5,7 @@ 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 plugin page!
+    # 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
diff --git a/src/main/resources/quests/example7.yml b/src/main/resources/quests/example7.yml
new file mode 100644
index 00000000..96bbb376
--- /dev/null
+++ b/src/main/resources/quests/example7.yml
@@ -0,0 +1,34 @@
+tasks:
+  building:
+    type: "blockplace"
+    amount: 10
+    worlds:
+      - "world"
+display:
+  name: "&cExample VI (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."
+    - ""
+    - "&7Rewards:"
+    - "&7 - $10 added to your in-game balance."
+  lore-started:
+    - ""
+    - "&7Your current progression:"
+    - "&7 - {building:progress}/10 blocks placed."
+  type: "GRASS_BLOCK"
+rewards:
+  - "eco give {player} 10"
+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