Configuration

Configuration

When Quests is first run, configuration files will be created in the /plugins/Quests directory. Each YAML configuration may vary depending on the version of Quests. However, examples of default configs and their values are provided below.

config.yml

language: en
allow-command-questing: true
allow-command-quests-with-npcs: false
show-requirements: true
allow-quitting: true
ignore-locked-quests: false
debug-mode: false
generate-files-on-join: true
kill-delay: 600
accept-timeout: 20
snoop: true
show-npc-effects: true
npc-effect: portal
max-quests: 0
convert-data-on-startup: false
quester-blacklist:
  - UUID
  - UUID
  - UUID
  - UUID

Key	Data Type	Description
language	string	Which language file ending in ".yml" will be used. For example, a value of "fr" will cause "fr.yml" to be loaded.
allow-command-questing	true/false	Whether or not players are allowed to accept and manage quests via command (e.g. /quests take SomeQuest).
allow-command-quests-with-npcs	true/false	Whether players can accept/manage NPC quests via command.
show-requirements	true/false	Allow players to see requirements for quests.
allow-quitting	true/false	If players are permitted to quit quests after taking them.
ignore-locked-quests	true/false	Ignore locked quests when checking if a player has a quest.
debug-mode	true/false	Whether to print debug information if an error occurs while loading.
generate-files-on-join	true/false	Generate a player data files when that player first joins the server or only when they he/she first uses Quests.
kill-delay	number	How long (in seconds) a player should have to wait after they kill a player for a quest before they can kill that player again.
accept-timeout	number	How long (in seconds) a player should be able to accept/deny a quest before the prompt cancels automatically.
show-npc-effects	true/false	Play a particle effect near NPCs that have an available quest for a player within 32 blocks?
npc-effect	string	The particle effect to be played (ex. note, enchant, crit, spell, portal).
max-quests	number	Maximum number of quests a given player can have at any time.
convert-data-on-startup	true/false	Replace username references in player data files with UUIDs from Mojang's account database.
quester-blacklist	list	An unlimited list of unique user IDs (UUIDs) for players that are to be completely ignored by Quests.

data.yml

This configuration file is used to store which NPCs are to display GUIs to players and will be empty if no GUIs have been set. Don't edit this file unless you know what you're doing.

events.yml

events:
  ExampleEvent:
    message: <red>Event happened!
    potion-effect-types:
    - Speed
    - Jump
    potion-effect-durations:
    - 100
    - 25
    potion-effect-amplifiers:
    - 3
    - 2
  GoodJob:
    message: <green>Good job!
  DeathFail:
    fail-quest: true
  FishingStart:
    message: <yellow>Type 'rod' in chat to get a fishing rod!
  RodEvent:
    message: <green>Here you go!
    items:
    - name-fishing_rod:amount-1

quests.yml

quests:
  Miner:
    name: Stone Miner
    ask-message: <yellow>Could you mine <purple>10<yellow> blocks of <purple>Stone<yellow>, and deliver the <purple>10<yellow> pieces <yellow>of <purple>Cobblestone<yellow> to me?
    finish-message: <yellow>Well done. Here is your reward.
    redo-delay: 1800
    requirements:
      items:
      - name-wood_pickaxe:amount-1
      remove-items:
      - false
      fail-requirement-message: <red>You must have a <purple>Wooden Pickaxe<red> first.
    stages:
      ordered:
        '1':
          break-block-names:
          - stone
          break-block-amounts:
          - 10
    rewards:
      money: 1000
      quest-points: 1
  Hunter:
    name: Mob Hunter
    ask-message: <yellow>Kill an assortment of Mobs.
    finish-message: <yellow>Excellent. Here is a <purple>Diamond Sword<yellow>.
    requirements:
      quests:
      - Stone Miner
      fail-requirement-message: <red>Complete <purple>Stone Miner<red> first.
    stages:
      ordered:
        '1':
          death-event: DeathFail
          mobs-to-kill:
          - Pig
          mob-amounts:
          - 3
          finish-event: GoodJob
        '2':
          death-event: DeathFail
          mobs-to-kill:
          - Zombie
          mob-amounts:
          - 2
          finish-event: GoodJob
        '3':
          death-event: DeathFail
          mobs-to-kill:
          - Skeleton
          mob-amounts:
          - 1
    rewards:
      items:
      - name-diamond_sword:amount-1
      exp: 100
      quest-points: 1
  CatchFish:
    name: Catch Fish
    ask-message: <yellow>Catch some fish!
    finish-message: <yellow>Excellent. Here is some <green>experience<yellow>.
    requirements:
      quests:
      - Stone Miner
      fail-requirement-message: <red>Complete <purple>Stone Miner<red> first.
    stages:
      ordered:
        '1':
          start-event: FishingStart
          death-event: DeathFail
          chat-events:
          - RodEvent
          chat-event-triggers:
          - rod
          fish-to-catch: 5
    rewards:
      exp: 250