main/Reference

Quests


Example

quests:
  questName:
    name:  Your Quest Name
    npc-giver-id: 12
    block-start: World 12 3 -54
    redo-delay:  5000
    //This Event will fire when the Quest begins
    event: MyEvent
    //
    ask-message:  "<yellow>Please take this Quest!"
    finish-message:  "<green>You beat it!"

    requirements:
      items:
        - id-270:amount-1
      remove-items:
        - false

      quests: 
        - "Some Other Quest"

      fail-requirement-message:  "You do not meet the requirements!"

    stages:
      ordered:
        '1':
           items-to-deliver:
             - id-1:amount-20
           npc-delivery-ids:
             - 12
           delivery-messages:
             - "<npc>: Keep it up!"
             - "<npc>: I still need some more stone!"

        '2':
           mobs-to-kill:
             - Pig
             - Skeleton
           mob-amounts:
             - 10
             - 1
             
    rewards:

      money: 1000
      quest-points: 2
      items:
        - id-365:amount-10




for block-start: Put a Location like so: worldName X Y Z. Example -> block-start: World 100 40 650
For that example, the block located at 100 X, 40 Y and 650 Z, inside the world "World", will be the block players can right-click on to start the Quest.


Quest Attributes

name: Name of the Quest that will be displayed to the player

ask-message: Message that will be prompted to the player when they attempt to take the Quest.

finish-message: Message that will be prompted to the player when they attempt to take the Quest.

redo-delay: Time (in milliseconds) that a player must wait before being able to perform the Quest again.
Note: If not set, the Quest will only be able to be completed once

npc-giver-id: The ID of the Citizens NPC that will give out this Quest

block-start: The block that a player can right-click on to take this Quest, following the format: WorldName x y z

region: (WorldGuard required) The name of the WorldGuard region that a player must be inside to be able to take the Quest (via command)

event: Initial Event to fire when the player first begins the Quest

requirements: All requirements go inside this block (see example above, and Requirements section below)

rewards: All rewards go inside this block (see example above, and Rewards section below)


Stages

break-block-ids: 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.

Requirements

items: Items that are needed to start the Quest (For how to format entries in this list, read here)
remove-items: List of true/false's for whether to take the required items away from the player or not

money: Economy currency needed to start the Quest

quest-points: Quest Points needed to start the Quest

permissions: List of permission nodes needed to start the Quest

quests: List of Quests that need to have been completed already to start the Quest

quest-blocks: List of Quests that cannot have been completed to start the Quest

____ (Heroes required) ____

heroes-primary-class: Primary Heroes class needed to take the Quest

heroes-secondary-class: Secondary Heroes class needed to take the Quest
____ ____ ____ ____ ____ ____

fail-requirement-message: Message to print to the player if they do not meet the requirements (this is needed if you have any requirements)


Rewards

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 "<player>" 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

Mob Names

Bat
Blaze
CaveSpider
Chicken
Cow
Creeper
Enderman
EnderDragon
Ghast
Giant
IronGolem
MagmaCube
MushroomCow
Ocelot
Pig
PigZombie
Sheep
Silverfish
Skeleton
Slime
Snowman
Spider
Squid
Villager
Witch
Wither
Wolf
Zombie


Enchantment names

Power
Flame
Infinity
Knockback
Sharpness
BaneOfArthropods
Smite
Efficiency
Unbreaking
FireAspect
Knockback
Fortune
Looting
Respiration
Protection
BlastProtection
FeatherFalling
FireProtection
ProjectileProtection
SilkTouch
AquaAffinity


Color Names (for sheep shearing)

Black
Blue
Brown
Cyan
Gray
Green
LightBlue
Lime
Magenta
Orange
Pink
Purple
Red
Silver
White
Yellow


Message Colors

In messages, instead of using the traditional '&1' , '&2', '&a' etc. color codes, you could use any of the following (but it is allowed), but make sure to include the arrow brackets:
<black>
<darkblue>
<darkgreen>
<darkaqua>
<darkred>
<purple>
<gold>
<gray>
<darkgray>
<blue>
<green>
<aqua>
<red>
<pink>
<yellow>
<white>

<random>
<italic>
<bold>
<underline>
<strike>
<reset>


Denizens

Add script-to-run: (script name) inside a Stage, and when the Stage is complete, the script will run.
ONLY TASK SCRIPTS WORK


Events

Event Functions


message: "This is a message!"
Message to be sent to the player when the Event happens.

clear-inventory: true
Should the players inventory be cleared?

items:
Items that are given to the player(For how to format entries in this list, read here)

explosions: [World 25 10 20]
List of locations for explosions to occur (Same explosion size as TNT)

commands: ["smite <player>,broadcast Hey everybody!"]
List of commands to execute from the server console
Note: You may use <player> to specify the players name.

effects: [BLAZE_SHOOT]
List of effects (See below) to be played
effect-locations: [World 10 5 15]
List of locations for the effects to be played

storm-world: World
Name of the world for a storm to occur in
storm-duration: 400
Amount of time (in ticks) for the storm to happen

thunder-world: World
Name of the world for thunder to occur in
thunder-duration: 200
Amount of time (in ticks) for the thunder to happen

mob-spawn-locations: [World 90 40 33]
Locations for mobs to spawn at
mob-spawn-types: [Zombie]
Mob types (See above) to spawn
mob-spawn-amounts: [3]
Amount of mobs to spawn

lightning-strikes: [World 10 10 10]
Locations to strike lightning at

potion-effect-types: [SPEED]
Potion effect types (See below) to give the player
potion-effect-durations: [60]
Amount of time (in ticks) for the potion effects to last
potion-effect-amplifiers: [3]
Strength of the potion effects (1 is regular, but it can be any number. Weird things can happen if you go too high though!

hunger: 10
Set the players hunger to this number

saturation: 5
Set the players saturation to this number

health: 1
Set the players health to this number

teleport-location: World 10 10 10
Location to teleport the player to (Make sure not to put this one as a list of strings, just one)


Effects


BLAZE_SHOOT - Sound of a Blaze firing
BOW_FIRE - Sound of a bow firing
CLICK1 - A click sound
CLICK2 - A different click sound
DOOR_TOGGLE - Sound of a door opening or closing
EXTINGUISH - Sound of fire being extinguished
GHAST_SHOOT - Sound of a Ghast firing
GHAST_SHRIEK - Sound of a Ghast shrieking
ZOMBIE_CHEW_IRON_DOOR - Sound of a Zombie chewing an iron door
ZOMBIE_CHEW_WOODEN_DOOR - Sound of a Zombie chewing a wooden door


Potion Effects


BLINDNESS - Renders the player blind
CONFUSION - Nether portal "screen warp" effect
DAMAGE_RESISTANCE - Resist damage from other entities
FAST_DIGGING - Faster block-breaking
FIRE_RESISTANCE - Resist all fire damage
HARM - Instantly deal damage to the player
HEAL - Instantly heal the player
HUNGER - Make the players hunger decrease faster
INCREASE_DAMAGE - Increase damage to other entities
JUMP - Jump higher
POISON - Damage the player over time
REGENERATION - Slowly regenerate health over time
SLOW - Move slower
SLOW_DIGGING - Slower block-breaking
SPEED - Move faster
WATER_BREATHING - Infinite oxygen
WEAKNESS - Decrease damage to other entities