Quest pool configuration

Guide to configure a quest pool

Here is the default example for starters:

type: timed-random
name: "Daily quests"

difficulties:
  easy: 1
  medium: 1
  hard: 1

reset-frequency: 0 0 0 * * ?

menu-item:
  show-in-main-menu: true
  page: 1
  # Optional if you use unlock requirements
  locked-lore:
    - ""
    - "&cThis quest pool isn't unlocked yet!"
  item:
    material: WRITABLE_BOOK
    slot: 10
    name: "&a{name}"
    lore:
      - "&8View your quests"
      - "&7Total completed: &f{total_completed}"
      - ""
      - "&8Global ranking: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"
      - ""
      - "&eClick to view!"

menu:
  title: "{name}"
  rows: 6
  display-area: [ 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 23, 24, 25, 28, 29, 30, 31, 32, 33, 34, 37, 38, 39, 40, 41, 42, 43 ]
  has-back-button: true
  has-close-button: true
  filler:
    enabled: true
    item:
      material: black_stained_glass_pane
      name: " "
  custom-items:
    test-item:
      name: "Test"
      material: emerald
  items: {}

leveling:
  enabled: true
  menu:
    title: "{name} levels"
    rows: 6
    display-area: [ 19, 20, 21, 22, 23, 24, 25, 28, 29, 30, 31, 32, 33, 34, 37, 38, 39, 40, 41, 42, 43 ]
    allow-item-amounts: true
    has-back-button: true
    has-close-button: true
    items: {}
    custom-items: {}
    filler:
      enabled: true
      item:
        material: black_stained_glass_pane
        name: " "
  requirements:
    - 5
    - 10
    - 30
    - 50
    - 100
    - 200
    - 500
  level-matchers:
    default:
      interval: 1
      priority: 0
      rewards: {}
  custom-levels:
    level1:
      level: 1
      rewards:
        my-command-reward:
          type: command
          command: "[console] say {player} has reached level 1!"
          display: "&8+&aConsole message"
          
# Requirements to unlock the quest pool.
unlock-requirements:
  # If true, the quest pool will show in the main menu even if it is locked
  # Locked lore will be added as well to the menu item.
  always-show-in-menu: true
  # Required quests to be completed before this pool unlocks
  quests:
    - "pool_id:quest_name"
  # Required permissions to unlock the pool
  # This requires LuckPerms to work properly
  permissions:
    - "example.permission"

Let's break this down to smaller pieces for better understanding.

• type - Can be either global or timed-random. Global quest pools are made for story mode quest lines. From A to B and thats it. Players will see all (unlocked) quests in the pool. Timed random is a bit more interesting. It will randomly pick a set of quests from the pool quest folder.

• name - This is the name of the quest pool

• difficulties - This defines how should the timed-random quest pools pick quests. Here it will try to pick 1 easy, 1 medium, and 1 hard quest for the player. It has no effect for Global quest pools.

• reset-frequency - This is a cron scheduler definition. This is the thing that defines when should players get new quests. This example will give players new quests every day at midnight. It has no effect on Global quest pools. You can find help, how to configure Quartz (cron) scheduler here: http://www.cronmaker.com/

• menu-item - Determines how should this quest pool look like in the main quest menu.

  • show-in-main-menu - If false, the quest pool won't be shown in the main quest menu

  • page - You can define which page you want to display this in the main menu.

  • item - Menu item to display in the main menu. See here: Item config

• menu - Defines how should the quest pool menu look like for this quest pool.

  • title - Title of the menu inventory.

  • rows - How many rows should the chest menu have?

  • display-area - In what inventory slots can we put the quests that are in this pool.

  • has-back-button - Should the menu have a back button?

  • has-close-button - Should the menu have a close button?

  • filler - If enabled, not used inventory slots will be filled with the provided item.

  • items - Here you can override the default menu items the same way as they are in the main menu configuration. You don't have to copy-paste the whole thing, since the items will be merged.

  • custom-items - You can add custom items to your menus. Make sure the keys are always unique.

• leveling - If enabled, a leveling menu and progression system will be created for the quest pool.

  • menu - Basically the same as above.

  • requirements - This defines how many levels will be created. This numbers are representing the number of quests required to level up.

  • level-matchers and custom-levels - This is a more advanced topic. These will define the rewards for each level. For a detailed explanation please read here: https://docs.auroramc.gg/auroralevels/configuration/main-config#level-matchers

• unlock-requirements - If it is present in the file, you can specify what permissions the player needs to have and/or what quests he/she should complete before accessing this quest pool.