Main configuration

config.yml configuration guide

The main config file is config.yml. You can configure your quest level up/complete actions, custom command aliases, language, quest difficulties, and leaderboards here.

Base options

debug - If it is enabled (true), then the plugin will log additional information about what it is doing and what is happening. Only allow this if the developer asks you.

language - This will determine what language the plugin will use for command messages. If the file doesn't exist, a new one will be generated from the default English file.

prevent-creative-mode - Will prevent progression for players that are in creative mode if set to true.

Unlock task

If you are doing some very wild things with your quest/pool unlocking, you might need to enable this to periodically check if players are unlocked quests/pools. Interval is in seconds.

Generally, you shouldn't need this.

unlock-task:
  enabled: false
  interval: 5

Command aliases

You can override the base commands and every user subcommand to fit your language.

command-aliases:
  quests: [ "quests", "quest" ]

Make sure to keep at least one alias always otherwise the plugin will break.

Display components

This is for more advanced templating. Currently, only rewards are supported for this.

display-components:
  rewards:
    title: "  &7Rewards:&r"
    line: "    {reward}"

The title will be the first line in the item lore or level-up message. Every reward will be placed on the {reward} in its new line.

Difficulties

The keys will be the IDs and the values will be the names of the difficulties. You need to use the IDs in your Quest Pool configs to properly pick quests for players.

difficulties:
  easy: "Easy"
  medium: "Medium"
  hard: "Hard"

In what order should the quests be sorted in the menus based on their difficulties?

sort-order: [ "easy", "medium", "hard" ]

Leaderboards

leaderboards:
  # How many players should we cache to create leaderboard placeholder for them?
  cache-size: 10
  # How many quests should be completed in the quest pool, before someone is added to the leaderboard?
  min-completed: 3
  # Should we include global quest pools? It is not recommended if you don't have a lot of difficult quests.
  include-global: false