A plugin for Spigot servers that implements randomly generated basic quests with rewards for players.
Author: Tonnanto
Current Version: 0.3.2
A spigot compatible Server is required to run this plugin!
Download the plugin and find the Project Page on SpigotMC and Bukkit.
Every player is given a set amount of quests initially (default: 3).
You can view your active quests by using /quests or /quests detail.
When a player completes a quest the reward can be received by clicking the "Collect Reward" button in the chat or by using /getreward.
As soon as a quests reward is collected it disappears from the list of quests, and a newly generated quest will be added to the list.
By default, a player is allowed to skip one quest every 24h by using /skipquest.
Some quests require the player to complete an advancement before they can be generated. Quests in the nether for example require the player to have completed the "Diamonds!" advancement.
Also, newly generated quests will increase in their quantities proportional to the players' playtime on the server: While a new player might receive a quest like "Mine 32 Iron Ore" a player with lots of playtime on the server would rather receive a quest like this "Mine 512 Iron Ore".
This feature can be precisely adjusted in the config.yml or be turned off entirely.
Some quests are incredibly rare but promise very high rewards once completed.
Quests are randomly generated in Basic Quests. Currently available quest types along with some examples are listed below:
- Mine Block
- Kill Entity
- Harvest Block
- Chop Wood
- Enchant Item
- Find Structure
- Trade with Villager (new)
- Gain Level
- Reach Level
- Break Block
Quest ideas I am thinking about implementing in the future:
- Fish Item
- Breed Animal
- Tame Animal
- Smelt Item
- Brew Potion
Possible Rewards are either Items, Money or XP. You can enable or disable each of these reward types in the config.yml.
By default, only item-rewards are enabled. In order to use money-rewards you need to have an economy plugin connected via Vault.
If multiple reward types are enabled one will be chosen at random when a new quest is generated - at least one reward type must be enabled or BasicQuests will not work.
The value of a reward is proportional to the value of the quest and is multiplied by the reward-factor which can also be adjusted in the config.yml.
The value of a given quest is determined by a number of factors along its generation process.
While money and xp-rewards are self-explanatory I'll list some examples for item-rewards below:
- Tools (Iron - Netherite) (Maybe enchanted)
- Armor (Chainmail - Netherite) (Maybe enchanted)
- Enchanted Books
- Potions (Only positive effects - extended (+) and upgraded (II) variants)
- Food
- Resources (Most of the valuable things you can find underground - From Flint to Netherite)
- Rare Items (Enchanted Golden Apple, Music Disks, Saddle, ...)
BasicQuest allows admins to fine tune the quest generation on their servers using a bunch of yaml files in the quest_generation directory.
This allows for:
- adjusting or removing the probability of quest types
- adjusting or removing the probability specific quests within a quest type
- making certain quests more or less valuable. This will be reflected in the value of the reward.
- adjusting the amounts that appear in quests.
For further information about how to fine tune the generation process check out the readme file at plugins/BasicQuests/quest_generation/README.md
You now know what type of Quests and Rewards are available.
Here are some examples of randomly generated Quests along with their Rewards.
Remember that there are a lot of possibilities to tweak the Quest and Reward generation in the config.yml and in the quest_generation files.
Reward:
- 1 Iron Shovel: Efficiency IV
Reward:
- 1 Enchanted Book: Sharpness V
- 1 Enchanted Golden Apple
Reward:
- 3 Saddle
Reward:
- 1 Netherite Sword
Reward:
- 1 Diamond Leggings: Unbreaking III
Reward:
- 1 Enchanted Golden Apple
- 6 Potion: Water Breathing
- 3 Potion: Invisibility +
Reward:
- 1 Netherite Chestplate: Fire Protection IV
- 1 Netherite Boots: Feather Falling III
- 24 Ender Pearl
- 24 Slime Ball
Reward:
- 1 Diamond Sword: Looting I
Reward:
- $336
Reward:
- 1 Iron Chestplate
- 16 Coal
Reward:
- 737 XP
Reward:
- 1 Enchanted Book: Looting III
Reward:
- 1 Enchanted Book: Mending
Reward:
- 20 Iron Ingot
- 1 Iron Chestplate
Reward:
- 4 Potion: Instant Health II
Reward:
- 64 Iron Ingot
Reward:
- $480
Reward:
- 1 Enchanted Book: Thorns II
- 1 Jukebox
Reward:
- 1 Iron Boots
- 1 Iron Pickaxe
Reward:
- 1 Enchanted Golden Apple
- 1 Bow
Reward:
- 840 XP
Reward:
- 44 Cooked Chicken
Reward:
- 1 Golden Apple
- 1 Iron Sword
Reward:
- 864 XP
Reward:
- 52 Cooked Porkchop
Reward:
- $160
Reward:
- 3 Diamond
Reward:
- 1 Diamond Sword
- 6 Splash Potion: Speed +
Reward:
- 1 Enchanted Book: Protection IV
- 2 Splash Potion: Regeneration +
Reward:
- $1,536
Reward:
- 36 Golden Carrot
- 3 Splash Potion: Night Vision +
Reward:
- 12 Amethyst Shard
Reward:
- 64 Gold Ingot
- 1 Enchanted Book: Silk Touch
Reward:
- 672 XP
Reward:
- $1,440
- 1 Netherite Pickaxe: Efficiency V
Reward:
- 12 Golden Apple
Reward:
- 276 XP
Reward:
- 64 Diamond
- 1 Netherite Sword: Unbreaking III
- 1 Enchanted Book: Fire Aspect II
- 1 Bow: Power V
Reward:
- 1 Netherite Shovel: Mending
- 1 Enchanted Book: Respiration III
Reward:
- 1 Netherite Chestplate
- 64 Gold Ingot
BasicQuests supports the following placeholders:
%bquests% A (multiline) list of the players quests (same output as /quests command)
%bquests_detail% A (multiline) list of the players quests and rewards (same output as /quests detail command)
%bquests_count% The amount of quests the player has
%bquests_<index>% The players quest at the given index
%bquests_<index>_title% The title of the players quest at the given index
%bquests_<index>_progress% The progress of the players quest at the given index: "1/16" or "Completed!"
%bquests_<index>_left% The amount left of the players quest at the given index: "15 left"
%bquests_<index>_<linenumber>% The title of a given quest split into 4 lines that fit on a sign. (linenumber can be 1 - 4, Check the example below)
%bquests_<index>_reward_<linenumber>% The reward of a given quest split into 2 lines. Handy for Scoreboards. (linenumber can be 1 - 2, Check the example below)
The PlaceholderSIGN plugin can be used to display quests on signs like so. You can see which placeholders have been used on the right. (Leave away the dot after the first %)
Scoreboard plugins like AnimatedScoreboard can be used to display quests on a custom scoreboard. Two examples along with the used placeholders are shown below.
####Quests with rewards:
Quests:
%bquests_1%
%bquests_1_reward_1%
%bquests_1_reward_2%
%bquests_2%
%bquests_2_reward_1%
%bquests_2_reward_2%
%bquests_3%
%bquests_3_reward_1%
%bquests_3_reward_2%
####Quests next to other plugins:
Quests:
%bquests_1%
%bquests_2%
%bquests_3%
Jobs:
...
Copyright (C) 2020 Anton Stamme anton@stamme.de
BasicQuests is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
BasicQuests is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with BasicQuests. If not, see https://www.gnu.org/licenses/.