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 a 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	What language file should we load? (It will add .yml to the end. The default is 'en' so it will look for en.yml)
allow-command-questing	true/false	Should players be allowed to take any Quest via command? (e.g. /quests take SomeQuest)
allow-command-quests-with-npcs	true/false	Should players be allowed to take NPC Quests via command?
show-requirements	true/false	If a player looks up information on a Quest, should the requirements be displayed?
allow-quitting	true/false	Should players be allowed to quit a Quest after they've taken it?
ignore-locked-quests	true/false	TODO
debug-mode	true/false	Should we print out debugging information if an error occurs while loading?
generate-files-on-join	true/false	Should Quests files be generated when players first join the server, or only when they first do Quest-related things?
kill-delay	number	How long (in seconds) should a player have to wait after they kill a player, before they can kill that player again (for a Quest objective)?
accept-timeout	number	How long (in seconds) should a player have to accept/deny a Quest before the prompt automatically cancels?
show-npc-effects	true/false	Should we play a visual effect near NPC's that have an available Quest for a player?
npc-effect	string	Which visual effect should we play? (ex. note, enchant, crit, spell, portal)
max-quests	number	TODO
convert-data-on-startup	true/false	TODO
quester-blacklist	list	If you are having problems with particular usernames (generally client mods and such), enter the usernames here and Quests will ignore them.

data.yml

This configuration file is only 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