Skip to content

Configuration

Jump to bottom Edit New page
FlyingPikachu edited this page Mar 20, 2015 · 37 revisions

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 result in "fr.yml" being 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 (e.g. /quests take SomeQuest).
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
Key Data Type Description
name string A name for the quest. This is what the player will see.
ask-message string Prompt sent to the player when he/she attempts to take the quest.
finish-message string A message sent to the player upon completing the quest.
npc-giver-id The ID of the Citizens NPC that will hand out this quest.
redo-delay number Time (in seconds) that a player must wait before taking the quest again.
gui-display itemstack Item to be displayed as the quest's GUI item. Will show the ask-message as lore if no lore is set.
block-start location A block that the player can right-click on to take the quest. Format is "worldName x y z".
region string Name of a WorldGuard region that a player must be inside in order to accept the quest (via command).
event list The initial event to run when the player starts the quest.
requirements list Items and such required to being the quest. See "Requirements" below.
stages ordered list Data for each stage including items to deliver, string messages, et al. See "Stages" below.
rewards list Money, items, quest points, and other prizes to give the player upon completing the quest. See "Rewards" below.
Requirements
Key Data Type Description
items itemstack Items required to begin the quest.
remove-items true/false Whether the required items should be removed from the quester's inventory.
money number Amount of currency required to start the quest.
quest-points number Amount of Quest Points required to start the quest.
quests list Quests that must have been already completed to take the quest.
quest-blocks list Quests that, once completed, disable the player's ability to take the quest.
heroes-primary-class Requires Heroes. Primary Heroes class needed to accept the quest.
heroes-secondary-class Requires Heroes. Secondary Heroes class needed to accept the quest.
fail-requirement-message Message to send to the player if the requirements are not met. This is necessary if a quest has any requirements.
Stages
Key Data Type Description
break-block-ids number IDs of blocks that need to be broken
break-block-amounts Amounts of blocks that need to be broken

| damage-block-ids | | IDs of blocks that need to be damaged (hit) | | damage-block-amounts | | Amounts of blocks that need to be damaged |

| place-block-ids | | IDs of blocks that need to be placed | | place-block-amounts | | Amounts of blocks that need to be placed |

| use-block-ids | | IDs of blocks that need to be used (Such as levers, doors, buttons etc.) | | use-block-amounts | | Amounts of blocks that need to be used |

| cut-block-ids | | IDs of blocks that need to be cut (Right click w/ shears) | | cut-block-amounts | | Amounts of blocks that need to be cut |

| fish-to-catch | | Number of fish that need to be caught |

| players-to-kill | | Number of players that need to be killed |

| enchantments | | Names of enchantments (for names, see below) that need to be enchanted to items | | enchantment-item-ids | | Item IDs that the enchantments need to be applied to | | enchantment-amounts | | Number of times the enchantments need to be enchanted on the items |

____ (Citizens 2 required) ____

| items-to-deliver | | Items that need to be delivered to an NPC (For how to format entries in this list, read here) | | npc-delivery-ids | | IDs of NPCs that the items must be delivered to | | delivery-messages | | List of random messages to print to the player when they deliver some (but not all) of the required items to the NPC. |

| npc-ids-to-talk-to | | IDs of NPCs that need to be interacted with (right-clicked) |

| npc-ids-to-kill | | IDs of NPCs that need to be killed | | npc-kill-amounts | | Number of times the NPCs need to be killed |

| mobs-to-kill | | Names of mobs (for names, see below) that need to be killed | | mob-amounts | | Amounts of mobs that need to be killed | | (Optional)locations-to-kill | | World and Coordinates that the mobs need to be killed at, following this format: WorldName x y z | | (Required if locations are put) kill-location-radii | | Radii that the mobs can be killed around. e.g. 10 would be 10 blocks around the location. | | (Required if locations are put) kill-location-names | | Names of the locations (e.g. Cave) | NOTE: do not try to put location-mob-killing with regular mob-killing in the same Stage

| locations-to-reach | | Locations that need to be reached, following this format: WorldName x y z | | reach-location-radii | | Radii around the locations that create a 'zone' the player can walk in and be considered 'at the location'. e.g. 10 would be 10 blocks around the location | | reach-location-names | | Names of locations (e.g. Cave) |

| mobs-to-tame | | Names of mobs (for names, see below) that need to be tamed | | mob-tame-amounts | | Amounts of mobs that need to be tamed |

| sheep-to-shear | | Colors of sheep (for color names, see below) that need to be sheared | | sheep-amounts | | Amounts of sheep that need to be sheared |

| password-displays | | List of questions to ask the player that they must answer | | password-phrases | | List of answers that the player must type in chat |

| script-to-run | | Name of Denizen script to be executed after the Stage is completed |

| objective-override | | This will be shown to the player as their current objective, rather than what the objectives would normally show. |

| start-event | | Name of Event (See Tutorial for creating Events)to fire when the Stage has begun. | | finish-event | | Name of Event to fire when the Stage is completed. | | disconnect-event | | Name of Event to fire when the player disconnects while on the Stage. | | death-event | | Name of Event to fire when the player dies while on the Stage. | | chat-events | | List of Events to fire when the player types respective chat triggers | | chat-event-triggers | | List of chat messages that fire respective events when the player types them in. |

Example

chat-events:

  • RodEvent
  • GoodJob chat-event-triggers:
  • i want a fishing rod
  • job This example will fire RodEvent when the player types "i want a fishing rod" (case insensitive), and GoodJob when the player types "job".

| delay | | Amount of time (in milliseconds) that the player must wait after completing this Stage, before the Quest will advance to the next one | | (Optional) delay-message | | Message sent to the player when the delay begins |

| start-message | | Message displayed at start of a stage. | | finish-message | | Message displayed at the completion of a stage. |

Rewards
Key Data Type Description
items Item rewards (For how to format entries in this list, read here)

____ (RPGItems required) ____

| rpg-item-ids | | IDs of RPG Items to give to the player |

| rpg-item-amounts | | Amount of each RPG Item to give to the player |

____ (PhatLoots required) ____

| phat-loots | | Names of PhatLoots to give to the player |

| money | | Economy currency given as a reward |

| exp | | Experience given as a reward |

| quest-points | | Quest Points given as a reward |

| commands | | List of commands to be executed by the server (You may put "" to refer to the player who completed the Quest. Leave slashes out.) |

| permissions | | List of permissions to be given to the player (NOTE: You must have some sort of Permissions plugin installed, SuperPerms will NOT work) |

mcMMO

| mcmmo-skills | | List of mcMMO skills to level up |

| mcmmo-levels | | Amount of levels to level up |

Skill names

Acrobatics All (Will give all mcMMO skills levels) Archery Axes Excavation Fishing Herbalism Mining Repair Swords Taming Unarmed Woodcutting

Add a custom footer
Add a custom sidebar
Clone this wiki locally