Quests.yml Configuration

Parameters

1. friendlyName (optional):

   • The display name for the quest, used in messages. If this option doesn't exist, the quest ID is used as a friendly name.

     friendlyName: Zombie Slayer

2. description (optional):

   • Description of the quest's objectives, shown, for example, in the quest's lore in the quest menu.

     description: The zombie apocalypse is upon us! Eliminate 20 zombies and collect their rotten flesh.

3. category (optional):

   • Specifies the category of the quest (e.g., combat, exploration, gathering). Use the ID of the category you want the quest to be added to. You can create new categories in the categories.yml file. If you don't specify a category, the quest won't show in the quest menu, useful, for example, for quests you only want players to be able to complete in a storyline.

     category: combat

4. material (optional):

   • Specify the material of the quest item in the menu. If it isn't specified, the first item in the requirements list is used. If there are no requirements, the default material is a book.

     material: PAPER

5. oneTime (optional):

   • Whether the quest can only be completed once (true) or can be repeated (false). The default value is false.

     oneTime: false

6. cooldown (optional):

   • Cooldown time before the quest can be repeated, in seconds. The default value is -1 so no cooldown exists.

     cooldown: 120

7. showCompletions (optional):

   • Whether to show the player how many times they have already completed the quest. The default value is false when the quest is one-time use; otherwise, it's true. It is displayed in the quest item's lore in the quest menu.

     showCompletions: true

8. requirements (required):

   • Conditions that must be met to complete the quest. Currently available options are items, killedEntities, placedBlocks, destroyedBlocks, blockInteractions, reachLocation, mobBreed and money.

     requirements: items: - material: ROTTEN_FLESH amount: 20 killedEntities: - entity: ZOMBIE amount: 2 placedBlocks: - material: DIRT amount: 2 worlds: - world - material: STONE amount: 6 destroyedBlocks: - material: DIRT amount: 2 worlds: - world - material: STONE amount: 6 blockInteractions: - location: [-602, 72, 283] world: "world" interactActions: - LEFT_CLICK - RIGHT_CLICK reachLocation: - world: world location1: [10, 10, 10] location2: [20, 20, 20] mobBreed: - entity: COW amount: 2 money: - amount: 10

   • resetType:

     • The type of reset for the requirement. Available options are NONE, ONLY_AMOUNT and COMPLETE. ONLY_AMOUNT will only remove the required amount of the quest fromm the database. COMPLETE will remove the complete database entry for this quest. The default value is NONE.

       requirements: killedEntities: - entity: ZOMBIE amount: 20 resetType: ONLY_AMOUNT

       This example will only remove 20 zombie kills from the database.

9. rewards (optional):

   • Rewards granted upon completing the quest. Currently available options are items, commands, and money if you have Vault and an economy plugin installed.

     rewards: items: - material: IRON_SWORD amount: 1 - material: GOLDEN_APPLE amount: 2 commands: - name: "1x Diamond Sword" command: "/give %player% diamond_sword" money: 2

10. requiredQuests (optional):

    • List of quests that must be completed before starting this quest.

      requiredQuests: - combat1

11. announce (optional):

    • Whether to send a chat message to all online players when the player has completed this quest. The default value is false.

      announce: true

Example