search

Tonnanto / BasicQuests

A plugin for Spigot servers that implements randomly generated basic quests with rewards for players.
GNU General Public License v3.0
11 stars 4 forks source link
bukkit java minecraft paper plugin quest spigot

readme

BasicQuests

A plugin for Spigot servers that implements randomly generated basic quests with rewards for players.

General

Author: Tonnanto
Current Version: 0.5

A spigot compatible Server is required to run this plugin!

Download the plugin and find the Project Page on SpigotMC and Bukkit.

How it works

Every player receives an initial number of quests (default: 3). You can view your active quests by using /quests list or /quests list rewards. When a player completes a quest, the reward can be received by clicking the reward button in the chat or by using /quests reward. As soon as a quest's reward has been collected, the quest disappears from the list, and a newly generated quest will be added.
By default, a player is allowed to skip one quest every 24h by using /quests skip. 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. Each quest is assigned a number of stars (⭐) based on its difficulty. Collect stars by completing quests and compete with others on the leaderboard which can be viewed using /quests leaderboard.

Quests

Quests are randomly generated in Basic Quests. Currently available quest types along with some examples are listed below:

Quest ideas I am thinking about implementing in the future:

Rewards

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:

Quest Generation Customization

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:

For further information about how to fine tune the generation process check out the readme file at plugins/BasicQuests/quest_generation/README.md

Example Quests

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.

Mine 144 Coal Ore (⭐⭐)

Harvest 32 Potatoes (⭐)

Chop 160 Logs (⭐⭐)

Enchant a Diamond Axe (⭐)

Fish a treasure (⭐⭐)

Find a Swamp Hut (⭐⭐⭐⭐⭐)

Harvest 48 Wheat (⭐)

Harvest 16 Potatoes (⭐)

Harvest 14 Chorus Flowers (⭐⭐⭐⭐⭐)

Find an End City (⭐⭐⭐⭐⭐)

Kill 10 Cows (⭐)

Mine 48 Nether Quartz Ore (⭐⭐⭐)

Enchant a Diamond Sword with Knockback I+ (⭐⭐)

Break 4 Amethyst Clusters (⭐⭐)

Find an Ocean Monument (⭐⭐⭐⭐)

Drive 600m in a Minecart (⭐⭐⭐⭐)

Catch 20 fish (⭐⭐)

Mine 4 Ancient Debris (⭐⭐⭐⭐)

Harvest 96 Carrots (⭐⭐)

Ride 2km on a Horse (⭐⭐⭐⭐)

Chop 64 Logs (⭐)

Play some Music (⭐⭐⭐⭐)

Level up 40 times (⭐⭐⭐)

Run 7,5km (⭐⭐⭐⭐)

Chop 160 Logs (⭐⭐)

Trade with a Leatherworker 4 times (⭐⭐)

Enchant a Diamond Boots with Swift Sneak I+ (⭐⭐⭐)

Find a Village (⭐⭐⭐)

Harvest 40 Nether Warts (⭐⭐⭐)

Harvest 80 Sugar Cane (⭐⭐)

Harvest 112 Beetroots (⭐⭐)

Find an Ocean Monument (⭐⭐⭐⭐)

Harvest 32 Sugar Cane (⭐)

Trade with a Farmer 2 times (⭐⭐)

Ring a Bell (⭐⭐⭐⭐)

Enchant a Diamond Chestplate with Unbreaking I+ (⭐⭐⭐)

Find an Ocean Ruin (⭐⭐⭐)

Find a Desert Pyramid (⭐⭐⭐)

Trade with a Villager 8 times (⭐⭐)

Reach level 45 (⭐⭐)

Kill 28 Endermen (⭐⭐⭐⭐⭐)

Trade with a Mason 8 times (⭐⭐⭐)

Find a Shipwreck (⭐⭐⭐)

Trade with a Cleric 4 times (⭐⭐⭐)

Mine 160 Coal Ore (⭐⭐)

Harvest 48 Brown Mushrooms (⭐⭐)

Reach level 45 (⭐⭐)

Enchant a Diamond Shovel with Fortune I+ (⭐⭐)

Level up 40 times (⭐⭐⭐)

Harvest 40 Red Mushrooms (⭐⭐)

Find a Desert Pyramid (⭐⭐⭐)

Enchant 6 Books (⭐⭐)

Trade with a Villager 12 times (⭐⭐⭐)

Break 6 Amethyst Clusters (⭐⭐)

Ride 11km on a Horse (⭐⭐⭐⭐⭐)

Travel 2km with a Boat (⭐⭐⭐)

Chop 64 Logs (⭐)

Run 15km (⭐⭐⭐⭐⭐)

Trade with a Cleric 6 times (⭐⭐⭐)

Travel 1km with a Boat (⭐⭐)

Enchant a Crossbow with Piercing III+ (⭐⭐⭐)

Harvest 48 Wheat (⭐)

Harvest 32 Bamboo (⭐⭐)

Harvest 32 Sugar Cane (⭐)

Find a Village (⭐⭐⭐)

Harvest 32 Sugar Cane (⭐)

Find a Nether Fortress (⭐⭐⭐⭐)

Chop 160 Logs (⭐⭐)

The following quests were generated with a quantity-factor of 3.0 instead of 1.0

Drive 5,5km in a Minecart (⭐⭐⭐⭐⭐)

Run 62,5km (⭐⭐⭐⭐⭐⭐⭐)

Mine 9 Emerald Ore (⭐⭐⭐⭐⭐)

Harvest 80 Nether Warts (⭐⭐⭐⭐)

Chop 128 Logs (⭐)

Harvest 96 Cocoa Beans (⭐⭐⭐)

Kill 60 Endermen (⭐⭐⭐⭐⭐⭐)

Mine 688 Coal Ore (⭐⭐⭐)

Mine 272 Iron Ore (⭐⭐⭐)

Harvest 336 Carrots (⭐⭐⭐)

Trade with a Fletcher 14 times (⭐⭐)

Kill 51 Magma Cubes (⭐⭐⭐⭐⭐⭐)

Chop 288 Jungle Logs (⭐⭐⭐)

Enchant a Diamond Chestplate with Unbreaking I+ (⭐⭐⭐)

Harvest 24 Brown Mushrooms (⭐⭐)

Placeholder

BasicQuests supports the following placeholders:

%bquests% A (multiline) list of the players quests (same output as /quests list)
%bquests_detail% A (multiline) list of the players quests and rewards (same output as /quests list reward)
%bquests_count% The amount of quests the player has
%bquests_completed% The amount of quests the player has completed
%bquests_top_<index>% The leaderboard of players with most completed quests (line by line)
%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)

Placeholder Examples

Signs

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 %)

Signs

Scoreboards

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%

Scoreboard 1

Quests next to other plugins:

Quests:
%bquests_1%
%bquests_2%
%bquests_3%

Jobs:
...

Scoreboard 2

License

Copyright (C) 2020-2024, Anton Stamme

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/.