Description
OpenQuests
βοΈ A complete quest system for your Hytale server. Build quest lines in the Asset Editor, and your players get goals, a journal, a tracker and rewards to chase.
No code required. Works in multiplayer and singleplayer, on new or existing worlds.
![]()
Combine quests as deep as you want and wire them together with AND and OR to get branching progression. Beat the guardian with a sword, or find another way around.
π¦ Want to see it in action? Install Adventure Quests next to OpenQuests: ready-made quest lines, in English and French, handed to your players as soon as the server starts.
β¨ What you get
π Everything in the Asset Editor. Autocompletion, validation, and inline definitions so a whole chain fits in a single file.
π§© Quests made of quests. A step is a quest like any other, with its own rewards. Nest them as deep as your story needs.
π Branching paths. OR lets the player choose their way through a chapter, AND asks for everything.
π A quest journal with chapters. /ojournal sorts your quests into chapters drawn as a map of how they lead into
one another, and opens again right where you left it.
π A tracker HUD. Titles, counters, nesting and timers. Players can hide or move it, and the server picks where it starts.
π Rewards to look forward to. Items, the next quests, commands, a prize drawn at random, or a popup where the player picks their own.
πΊοΈ Quests on the map. Every running quest shows where to go on the world map, and the tracked one on the compass.
β³ Rules on any quest. Time limits, worlds, cooldowns, caps: add them to any quest and combine them freely.
π Server-wide events. "Kill 1,000,000 skeletons, together" is a single quest shared by the whole server.
π An ending you can hear. A finished quest takes over the middle of the screen and plays the sound you choose.
π― English and French included. Every line of text is translatable.
π Chapters and the quest journal

Group your quests into chapters, and chapters into groups, each with its icon. A chapter is drawn as a map: every quest is a tile, and the arrows show which one opens the next.

- Hover a quest to read where it stands and what it asks, with the path leading to it lit up.
- A map as big as you need: scroll it both ways, or switch to a plain list of the chapter in one click.
- Three tabs: Chapters, Quests with a state filter and a search box, and Rewards, which turns gold when something waits to be collected.
- Rows that open on the story, every objective with its counter, and the rewards on offer.
- Tracking from the journal: put a quest, or a single step of a long chain, on the HUD in one click.

- Chains you can walk through: a reward or an objective naming another quest is a link, and the trail at the top takes you back.
- It remembers: close the journal, open it again, and you are back on the same tab, chapter and quest.

Lay chapters out in game. Players allowed to edit get an Edit button: pick a tile, drop it on another cell, and the chapter's file is written for you.
π― Quest types
| Type | Completes on |
|---|---|
Gather |
Holding a quantity of an item |
InteractivelyPickup |
Picking a quantity up by hand |
Craft |
Crafting a quantity of an item, whatever the recipe |
Consume |
Eating or drinking a quantity of an item |
CastSpell |
Casting spells, any or named by rune or keyword |
DropItem |
Throwing a quantity of an item out of the inventory |
PickupItem |
Picking a quantity of an item up, off the ground or by hand |
BreakBlock |
Breaking a number of blocks |
PlaceBlock |
Placing a number of blocks |
UseBlock |
Interacting with a block a number of times |
UseEntity |
Interacting with NPCs of a group |
KillNpc |
Killing NPCs of a group |
KillPlayer |
Killing players, optionally a designated one |
ReachLocation |
Entering a radius around a position, shown on the map and compass |
ReachPath |
Reaching a series of spots, in order or not: a parkour, a course |
EnterWorld |
Entering a world whose name matches a pattern |
ReachValue |
A game flag or a count of memories reaching a value |
TriggerVolume |
Entering trigger volumes, even in generated worlds |
Walk, Run, Sprint |
Covering a distance, or a time, at that pace |
Jump |
Jumping a number of times |
LoseStat |
Spending points of a stat: health, stamina, mana, oxygen |
Composite |
Its children, combined with AND or OR |
QuestState |
Another quest reaching a state: a prerequisite |
NoOp |
Nothing on its own: a command, a reward or your own plugin ends it |
Items and blocks are named by id, by tag, by family, such as any flower or any raw meat, or by crafting bench category. "AntiAbuse": true stops
the same item thrown and picked up, or the same block placed and broken, from counting twice.
π Rewards
| Type | Effect |
|---|---|
Item |
Gives items |
GrantQuest |
Hands the next quests over: this is how a chain continues |
Command |
Runs a server command, as the console or as the player |
Random |
Draws one of its rewards, each with its own weight |
Choice |
Opens a popup where the player picks what they get |
Effect |
Puts an effect on the player, a food buff or a potion |
Droplist |
Rolls one of the game's drop lists, such as a dungeon chest |

Rewards can be paid on success, on failure or on abandon, handed over at once or collected from the journal. If a reward cannot be delivered (full inventory, player offline), it waits. Nothing is lost.
β³ Constraints
| Type | Effect |
|---|---|
TimeLimit |
Ends the quest after a number of seconds, failed or successful |
Deadline |
Ends every quest from the asset at a set date |
Within |
Makes a count a combo: reach it in time or start again |
InWorld |
Only counts in some worlds; leaving can fail the quest |
NearPosition |
Only counts within a radius of a position |
EntityCondition |
Only counts while sprinting, out of combat, under an effect⦠|
RequiresQuest |
Only counts once, or while, another quest stands as asked |
MinPlayersOnline |
Only counts while enough players are online |
FailOnDeath |
Dying fails the quest |
Cooldown |
At most once per period, a day for a daily quest |
MaxQuests |
A set number of times, or one at a time |
The journal shows them with the time left, and a timed quest gets a countdown bar on the tracker.
π Who a quest belongs to
The same quest asset can be played four ways:
- π€ Player. Everyone runs their own copy, at their own pace.
- πͺ World. Shared by everyone inside a world, perfect for a dungeon: slay the boss, survive ten waves, light every brazier. Whoever is there at the end gets the reward.
- πΊοΈ Worlds. One quest across every copy of a dungeon: a daily hunt counting every run of the day.
- π Universe. One counter the whole community pushes. This is where a quest becomes a server event.
π¨ Make it yours
- Icons on every quest, chapter and group, taken from any item or model of the game or your own pack.
- Two texts per quest: a short line saying what to do, shown on the HUD, and a description that tells the story.
- Categories colour-code quests in the journal: Dungeon, Server event, Side questβ¦
- Secret quests appear only once earned, with
"Visibility": "WhenCompleted". - Sounds per outcome, from the game or your own asset pack.
- Auto-tracking puts a quest on the HUD the moment it is handed out.
- Default titles when you write none: a
Gatherquest reads Gather 2 Sticks by itself.
π οΈ For server owners
Installing
- βοΈ OpenQuests: this project, the quest types, rewards, journal and HUD
- βοΈ OpenQuests Core: the system underneath, which CurseForge installs with it
- π¦ Adventure Quests (optional): the ready-made quest lines
Installing by hand? Drop OpenQuests and OpenQuests Core in mods/. Nothing else to configure, and a missing reference
or a loop between quests stops the server at boot with a clear reason, not in front of a player hours later.
Writing a quest
Open it in the Asset Editor and change what you like, every field checked as you type:

Underneath, a quest is a JSON asset, steps included:
{
"Type": "Composite",
"TitleKey": "quest.basics.title",
"QuestAssetIds": [
"GatherSticks",
{ "Type": "Craft", "ItemToCraft": { "ItemId": "Weapon_Sword_Crude" }, "TargetQuantity": 1 }
],
"SuccessfulRewards": [
{ "Type": "Item", "ItemId": "Ingredient_Life_Essence", "Quantity": 25, "AutoClaim": true },
{ "Type": "GrantQuest", "QuestAssetIds": ["DefeatTheGuardian"] }
]
}
An assignment, beside it, says who gets it and when: on connection, on entering a world, or on a schedule, once or again and again.
Commands
| Command | Effect | Granted to |
|---|---|---|
/ojournal |
Opens the quest journal, also /journal and /quests |
hytale:Adventurer |
/oquest abandon <quest> |
Abandons your matching quests | hytale:Adventurer |
/oquest complete <quest> |
Completes them | hytale:WorldEditor |
/oquest fail <quest> |
Fails them | hytale:WorldEditor |
/oquest create player <assetId> <player> |
Hands a quest to a player | hytale:WorldEditor |
/oquest create world <assetId> <world> |
Shares a quest with a world | hytale:WorldEditor |
/oquest create universe <assetId> |
Shares a quest with the whole server | hytale:WorldEditor |
/ohud show, /ohud hide |
Shows or hides your quest tracker | hytale:Adventurer |
/ohud move --side=<side> --top=<n> |
Moves it, also --offset=<n> from the side |
hytale:Adventurer |
/ohud reset |
Puts it back where the server wants it | hytale:Adventurer |
/ohud default show and so on |
The same for everyone who chose nothing, kept in hud.json |
hytale:WorldEditor |
<quest> is a quest id or an asset id, and asset ids are suggested as you type. /oquest also answers to /quest
and /q.
Storage
Quests are saved as JSON under your universe, with nothing to set up. For a large server, or several servers sharing
their players, use a database in mods/MartelStudios_OpenQuestsCore/config.json:
{
"Storage": {
"Type": "Jdbc",
"Url": "jdbc:postgresql://localhost:5432/openquests",
"User": "openquests",
"Password": "β¦",
"DriverPath": "libs/postgresql-42.7.4.jar"
}
}
PostgreSQL, MySQL, MariaDB and SQLite are supported; drop your database's driver beside the server. Servers sharing a
database share server-wide quests and those spanning several worlds, and a player switching servers picks up where they
left off. To keep the password out of mods/, point the OPENQUESTS_CONFIG environment variable at a file elsewhere.
π» For developers
OpenQuests Core is the system on its own, with no quest type, and OpenQuests adds the quest types, rewards, journal and HUD, one package per feature: the reference for writing your own. A new quest type is one call:
QuestProgressionService.get().registerQuestType(
"MyType",
MyQuestAsset.class, MyQuestAsset.CODEC,
MyQuestProgression.class, MyQuestProgression.CODEC
);
Rewards, constraints, HUD and journal renderers are one line each, and the tracker and journal draw your type without
ever learning it exists. Declare "MartelStudios:OpenQuestsCore" or "MartelStudios:OpenQuests" in your
manifest.json.
Source and documentation: https://github.com/MartelStudios/OpenQuests
MIT licensed.












