Skip to content

Objectives

Objectives define what a player must do to complete a quest. Each quest has one or more objectives, and every objective has a type, a target, and a count.

The quest editor of the admin window offers the 20 objective types that Quests counts, each with a matching picker for its target.

Every objective in your quest JSON follows this structure:

{
"id": "obj_1",
"type": "blocks_mined",
"target": "Ore_Copper*",
"count": 20,
"description": {
"en": "Mine Copper Ore (0/20)",
"de": "Baue Kupfererz ab (0/20)"
}
}
FieldRequiredDescription
idYesUnique identifier within the quest (e.g. obj_1, obj_2)
typeYesThe objective type (see table below)
targetYesWhat to target — item ID, mob name, zone, or "any"
countYesHow many times the action must be performed
descriptionNoLocalized display text shown in the quest book
consumeItemsNoIf true, collected items are removed from inventory on turn-in
deliverToNoNPC (citizen ID) a deliver objective is handed in at
hiddenNoIf true, objective is hidden until revealed
revealConditionNoWhen to reveal a hidden objective: on_progress, on_complete, or manual
conditionsNoAdditional conditions (biome, zone, weather, time of day, tool)
revealOnFailNoIf true, hidden objective is revealed when the quest fails
failMessageNoLocalized failure message (e.g. {"en-US": "Failed!", "de-DE": "Fehlgeschlagen!"})
TypeDescriptionExample Targets
blocks_minedMine stone, ores or other mineable blocksRock_Stone, Ore_*, any
blocks_choppedChop trees and woodWood_Oak*, any
blocks_dugDig dirt, sand or gravelSand_*, Dirt_*, any
blocks_placedPlace blocks in the worldBench_WorkBench, Furniture_Crude_Torch
blocks_harvestedHarvest crops (F-key interaction)Plant_Crop_Wheat*, any
flowers_pickedPick flowersPlant_Flower_Common_Red, any
Example: Mine ores and place a furnace
"objectives": [
{ "id": "obj_1", "type": "blocks_mined", "target": "Ore_*", "count": 30 },
{ "id": "obj_2", "type": "blocks_placed", "target": "Bench_Furnace", "count": 1 }
]
TypeDescriptionExample Targets
killsKill NPCs or mobsGoblin_*, Fen_Stalker, any_mob
player_killsKill other playersplayer
damage_dealtDeal damage to entitiesScorpion, any
damage_takenReceive damageany
Example: Hunt goblins and survive damage
"objectives": [
{ "id": "obj_1", "type": "kills", "target": "Goblin_*", "count": 10 },
{ "id": "obj_2", "type": "damage_taken", "target": "any", "count": 1000 }
]
TypeDescriptionExample Targets
items_craftedCraft items at a workbench or furnaceWeapon_Sword_*, Potion_*, Bench_Furnace
items_collectedCollect items (enter inventory)Ore_*, @consumable, Plant_Flower_Common_Red
deliverHand items over to an NPCItem ID or pattern, plus deliverTo
Example: Gather food items (any edible item counts)
"objectives": [
{ "id": "obj_1", "type": "items_collected", "target": "@consumable", "count": 5 }
]

A deliver objective counts items the player hands over to a quest giver. Set the NPC with deliverTo (a citizen ID):

Example: Deliver 20 logs to Old Oak
"objectives": [
{ "id": "obj_1", "type": "deliver", "target": "Wood_*", "count": 20, "deliverTo": "lumberjack_oak" }
]

When the player talks to that NPC, the delivery confirmation shows exactly what it takes. Items are only taken after Hand in, only what is still missing, and only what really left the inventory counts. Without deliverTo the items can be handed in at any NPC (the admin window warns about that).

:::caution items_consumed items_consumed is still read from quest files but is not counted by Quests 2.1. Use items_collected or deliver instead. :::

TypeDescriptionExample Targets
distance_traveledWalk a certain number of blocksMust be "any"
zone_discoveredDiscover named zonesmarketplace, ancient_ruins, any
playtime_minutesPlay for a duration (minutes)"any" or "total"
Example: Explore the world
"objectives": [
{ "id": "obj_1", "type": "distance_traveled", "target": "any", "count": 3000 },
{ "id": "obj_2", "type": "zone_discovered", "target": "ancient_ruins", "count": 1 }
]

:::warning zone_discovered vs zones_discovered Use zone_discovered (singular) for quest objectives. The plural form zones_discovered is used only in the achievement system for cumulative tracking. :::

:::warning Important: distance_traveled The target for distance_traveled must always be "any". Setting it to anything else (like "walking" or "running") will cause the objective to never progress. :::

TypeDescriptionExample Targets
interact_npcTalk to a specific NPC (alias talk_to_npc)NPC citizen ID, e.g. guide_finn
command_executedExecute a server commandCommand name (lowercase, no /)

complete_hub_quests is not counted by Quests 2.1 (see Hub Quests).

Example: Collect ores and deliver to an NPC
"objectives": [
{ "id": "obj_1", "type": "items_collected", "target": "Ore_*", "count": 20 },
{ "id": "obj_2", "type": "interact_npc", "target": "guide_finn", "count": 1 }
]
Example: Execute a command
"objectives": [
{ "id": "obj_1", "type": "command_executed", "target": "home", "count": 1 }
]

:::info command_executed The command_executed objective tracks when a player types a command in chat. The target is the command name in lowercase without the / prefix. For example, to track when a player uses /home, set "target": "home". :::

TypeDescriptionTarget / Count
level_reachedReach a player level (needs a leveling plugin)target = the level, e.g. "10". The count is fixed at 1
waitWait a number of seconds after the quest startedno target, count = seconds
Example: Reach level 10, then wait one minute
"objectives": [
{ "id": "obj_1", "type": "level_reached", "target": "10", "count": 1 },
{ "id": "obj_2", "type": "wait", "count": 60 }
]

level_reached completes right away when the player already has the level, and is checked again after level-ups. Wait timers survive relogs and restarts.

From Quests 2.1.9 (not released yet, not tested in game). They need KyuubiSoft Guilds, which reports the progress. The quest editor shows them as a fifth row of objective types. No shipped quest uses them; build your own quests on them.

TypeDescriptionTarget / Count
guild_joinJoin a guild. Founding counts as joiningno target, count 1. Counts once per player, so leaving and joining again does not count twice
guild_createFound a guildno target, count 1. Once per player
guild_levelThe player’s guild reaches a leveltarget = the level number, e.g. "5". Levels already reached count again on joining and login
guild_lockLock chests or doors for the guildno target, count = locks. Each locked spot counts once per player
guild_donateHand in building material for the guild leveltarget = item id, or any for any material; count = pieces
Example: Join a guild, then hand in 64 planks
"objectives": [
{ "id": "obj_1", "type": "guild_join", "count": 1 },
{ "id": "obj_2", "type": "guild_donate", "target": "Wood_Softwood_Planks", "count": 64 }
]

The check view of the admin window warns when a quest uses guild objectives while KyuubiSoft Guilds is not running, because they would never progress then. A guild_level target must be a number.

With KyuubiSoft Guilds installed, every completed quest also gives the player’s guild experience, within the guild’s daily limit per member.

Targets determine what counts toward an objective. The system supports several matching patterns:

PatternSyntaxExampleMatches
Any"any""target": "any"Everything of that type
ExactFull ID"target": "Rock_Stone"Only Rock_Stone
WildcardEnds with *"target": "Ore_*"Ore_Iron, Ore_Copper, Ore_Gold, …
Groupgroup:Name"target": "group:Stone"All blocks in the Stone group
Property@property"target": "@consumable"All items with isConsumable() = true
Multi-targettargets array"targets": ["Ore_Iron", "Ore_Copper"]Both iron and copper ore

For items_collected and items_consumed objectives, you can use @ prefixed property targets that match items based on their game properties rather than their ID:

TargetMatchesNotes
@consumableAll edible itemsIncludes Food_*, Plant_Fruit_*, cooked items, etc.

:::tip Why @consumable instead of Food_*? Edible items in Hytale use various ID prefixes (Food_*, Plant_Fruit_*, etc.). Using @consumable matches all edible items regardless of their naming pattern, making your quest more robust. :::

Use the targets array (plural) to match multiple specific targets in a single objective:

{
"id": "obj_1",
"type": "blocks_mined",
"targets": ["Ore_Iron", "Ore_Copper", "Ore_Gold"],
"count": 30
}

Set "sequential": true on the quest to require objectives to be completed in order. Players must finish obj_1 before obj_2 starts tracking.

{
"objectives": [
{ "id": "obj_1", "type": "blocks_chopped", "target": "any", "count": 8 },
{ "id": "obj_2", "type": "items_crafted", "target": "Bench_WorkBench", "count": 1 },
{ "id": "obj_3", "type": "blocks_placed", "target": "Bench_WorkBench", "count": 1 }
],
"sequential": true
}

When consumeItems is true, the collected items are removed from the player’s inventory when the quest is turned in. The items are checked first: while any are missing, nothing is completed or taken. For handing items to an NPC, the deliver objective is usually the better choice.

{ "id": "obj_1", "type": "items_collected", "target": "Wood_*", "count": 20, "consumeItems": true }

Hidden objectives are meant to stay out of the quest book until a reveal condition is met.

{ "id": "obj_secret", "type": "zone_discovered", "target": "hidden_cave", "count": 1, "hidden": true, "revealCondition": "on_progress" }
Reveal ConditionBehavior
on_progressRevealed as soon as any progress is made
on_completeRevealed only when the objective is completed
manualMust be revealed via admin command or trigger

These optional conditions are meant to restrict where or when an objective can be progressed (not applied in 2.1, see above):

{ "id": "obj_1", "type": "blocks_mined", "target": "Ore_*", "count": 20,
"conditions": { "biome": "desert", "timeOfDay": "night", "tool": "Tool_Pickaxe_Iron" } }
ConditionValuesDescription
biomeBiome IDOnly counts in this biome
zoneZone nameOnly counts in this zone
weatherclear, rain, stormOnly counts during this weather
timeOfDayday, night, dawn, duskOnly counts at this time
toolItem IDOnly counts when using this tool
minLevelNumberPlayer must be at least this level
requiredBuffBuff IDPlayer must have this active buff