diff options
Diffstat (limited to 'src/main/resources/quests')
| -rw-r--r-- | src/main/resources/quests/README.txt | 30 | ||||
| -rw-r--r-- | src/main/resources/quests/example1.yml | 55 | ||||
| -rw-r--r-- | src/main/resources/quests/example2.yml | 42 | ||||
| -rw-r--r-- | src/main/resources/quests/example3.yml | 45 | ||||
| -rw-r--r-- | src/main/resources/quests/example4.yml | 39 | ||||
| -rw-r--r-- | src/main/resources/quests/example5.yml | 34 | ||||
| -rw-r--r-- | src/main/resources/quests/example6.yml | 30 |
7 files changed, 275 insertions, 0 deletions
diff --git a/src/main/resources/quests/README.txt b/src/main/resources/quests/README.txt new file mode 100644 index 00000000..fa0f0186 --- /dev/null +++ b/src/main/resources/quests/README.txt @@ -0,0 +1,30 @@ +# !! 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. +# +# 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 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 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. +# +# =============================================================== +# +# You can see other task types here: +# https://github.com/LMBishop/Quests/wiki/Task-Types +# +# ===============================================================
\ No newline at end of file diff --git a/src/main/resources/quests/example1.yml b/src/main/resources/quests/example1.yml new file mode 100644 index 00000000..7e38f01f --- /dev/null +++ b/src/main/resources/quests/example1.yml @@ -0,0 +1,55 @@ +# 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 plugin page! + 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 30 blocks." + - "" + - "&7Rewards:" + - "&7 - 10 diamonds." + # 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." + # This is the material of the item. It is recommended to stick to bukkit names. + type: "WOOD_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" + +# 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 the quest IDs of required quests here, leave empty if none. + requires: + - "" + # 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
\ No newline at end of file diff --git a/src/main/resources/quests/example2.yml b/src/main/resources/quests/example2.yml new file mode 100644 index 00000000..8a3a367f --- /dev/null +++ b/src/main/resources/quests/example2.yml @@ -0,0 +1,42 @@ +# 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 100 blocks." + - "&7 - Place 100 blocks." + - "" + - "&7Rewards:" + - "&7 - 15 diamonds." + - "&7 - $50 added to your in-game balance." + lore-started: + - "" + - "&7Your current progression:" + - "&7 - {mining:progress}/100 blocks broken." + - "&7 - {building:progress}/100 blocks placed." + type: "GRASS" +rewards: + - "give {player} diamond 15" + - "eco give {player} 50" +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
\ No newline at end of file diff --git a/src/main/resources/quests/example3.yml b/src/main/resources/quests/example3.yml new file mode 100644 index 00000000..598b94d1 --- /dev/null +++ b/src/main/resources/quests/example3.yml @@ -0,0 +1,45 @@ +# 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: 14 # (gold ore) + building: + type: "blockplacecertain" + amount: 9 + block: 41 # (gold blocks) +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 81 gold ore." + - "&7 - Place 9 gold blocks." + - "" + - "&7Rewards:" + - "&7 - 30 diamonds." + - "&7 - $10 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." + type: "GOLD_ORE" +rewards: + - "give {player} diamond 30" + - "eco give {player} 10" +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
\ No newline at end of file diff --git a/src/main/resources/quests/example4.yml b/src/main/resources/quests/example4.yml new file mode 100644 index 00000000..37744eee --- /dev/null +++ b/src/main/resources/quests/example4.yml @@ -0,0 +1,39 @@ +# This is a quest which requires the previous quest to be complete to start. +# Unlike the previous quests, this quest has a reward 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 3 mobs." + - "" + - "&7Rewards:" + - "&7 - $50 added to your in-game balance." + lore-started: + - "" + - "&7Your current progression:" + - "&7 - {mobkilling:progress}/3 mobs killed." + type: "STRING" +rewards: + - "eco give {player} 50" +# Here you can list messages which will be sent to the player (if they are online) upon completion. +rewardstring: + - " &8* &c$10 &7was added to your in-game balance." + - " &8* &c30 diamonds &7was added to your inventory." +options: + category: "examples" + requires: + - "example3" + repeatable: true + cooldown: + enabled: true + time: 10
\ No newline at end of file diff --git a/src/main/resources/quests/example5.yml b/src/main/resources/quests/example5.yml new file mode 100644 index 00000000..38e9e601 --- /dev/null +++ b/src/main/resources/quests/example5.yml @@ -0,0 +1,34 @@ +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 10 blocks." + - "" + - "&7Rewards:" + - "&7 - $10 added to your in-game balance." + lore-started: + - "" + - "&7Your current progression:" + - "&7 - {building:progress}/10 blocks placed." + type: "GRASS" +rewards: + - "eco give {player} 10" +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
\ No newline at end of file diff --git a/src/main/resources/quests/example6.yml b/src/main/resources/quests/example6.yml new file mode 100644 index 00000000..3262b1a8 --- /dev/null +++ b/src/main/resources/quests/example6.yml @@ -0,0 +1,30 @@ +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 10 blocks." + - "" + - "&7Rewards:" + - "&7 - $10 added to your in-game balance." + lore-started: + - "" + - "&7Your current progression:" + - "&7 - {building:progress}/10 blocks placed." + type: "GRASS" +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
\ No newline at end of file |