Description
Quest Generator
Requires CommandDeck 1.3.0 or later, Generous Operator 1.1.0 or later and Mod Settings Manager 1.0.2 or later.
The building blocks and scaffolding for quests and quest chains in Hytale. Quest Generator doesn't tell a story of its own. It gives you the parts: steps that listen to what players do, gates that wait for the right moment, actions that set the scene, and links that join one quest to the next. Then it does the running for you: the Quest Log, progress saved across restarts, rewards, cleanup, and the fixes an operator needs when something gets stuck.
Quests are data files. A mod ships them, or an operator builds them in the game with the quest constructor. Quest packs (separate mods) bring the stories; Quest Generator is what they're built on.
The building blocks
Steps: what the player does
A quest is a series of steps, and each step has one or more objectives. These are the kinds of objective available now, each built on the game's own events:
| Objective | The player... |
|---|---|
collect |
holds a number of something |
find |
picks up items the quest hid |
craft |
crafts something |
break, place |
breaks or places blocks |
use |
uses a block or an NPC |
talk |
reaches a line in a giver's dialogue |
speak |
says a word or phrase in chat |
turn_in, contribute |
hands items to an NPC, or adds them to a shared tally |
kill |
defeats an NPC, a kind or a group, optionally by a cause (an arrow, fire) |
damage |
wounds something |
die |
dies, optionally of a cause |
shoot |
fires or throws a projectile |
reach, leave |
gets to a place, or leaves an area |
discover |
discovers a zone for the first time |
enter |
goes through a portal or into an instance |
wait |
waits, or waits until a gate holds |
A step can also offer choices: several ways forward, each its own branch, which can join up again later.
Gates: when it can happen
Steps, objectives and dialogue answers can wait on conditions (from CommandDeck): time of day or night, weather, moon phase, zone, underground or in a dungeon, in or near water, holding, wearing or carrying something, health and other stats, movement (sprinting, gliding, swimming, crouching), out of combat, light level, game mode, in an area or near an NPC, the quest's own state, and "held for a while" (stand by the host for 20 seconds; keep the lantern lit until dawn). Gates can be combined with all, any and not, and can be about an NPC instead of the player ("while the bear is below half health").
Actions: setting the scene
Steps can hide items to find, place blocks and chests (in plain sight or buried), put markers on the map and light the way, send messages and on-screen banners, and give rewards: Generous Operator kits, or boons with BuffEffects. Items, blocks and chests a quest put into the world are cleaned up when it ends.
Chains: one quest leading to another
Quests remember. A quest can require another to be finished first (even another mod's), check facts an earlier quest shared (a choice made, a count reached), and know which way a player came in. Silent quests notice things a player did without announcing it ("You read the gravestone by the old oak"), and a later quest can open an option because of it. Shared quests give the whole server one goal, with a running tally and a leaderboard. With Calendar & Seasons installed, a quest can start on a holiday and end when the holiday does.
The scaffolding
- The Quest Log. Type
/quest. Active quests with each step's goal and count ("Torches placed: 2 of 3"), a hint if you're stuck, and a timer where there is one; completed quests with their history; quests on offer; the server's own quests; and samples. Track up to three on screen, in Hytale's own objective tracker. - Banners. "New Quest" and "Quest Complete" on screen, with a chat line too, so nothing is missed while a window is open.
- Givers and dialogue. NPCs that offer quests, with clickable answers in a dialogue window. Keywords typed in chat work too.
- Rewards you can trust. Every reward goes through Generous Operator's trust and power checks and into its gift log, so a quest never hands out more than the server allows.
- Saved as it goes. Progress and timers survive restarts and logouts.
- Operator fixes. See where any quest stands, stop it, or let a player take it again, from commands or buttons.
- Checked when it loads. A quest file with a mistake is refused, with a log line naming the file, the quest and the problem. Everything else still loads.
The quest constructor (operators)
Type /quest construct to put a quest together in the game, from a template:
- Hunt: hidden items scattered around a place, Easter-egg style, alone or as a server-wide race.
- Treasure: a chest somewhere near, with the way to it. Easy follows the lights; Medium gives only its coordinates. With Hal's Mapper, the chest waits in a real cave at the end of a route.
- Errand: a short line of plain steps: go there, talk to them, fetch these, come back.
- Epic: start from nothing and add any steps you like.
The quest is written out on the left as you go, with a readout of whether it's ready, which mods it needs, and whether its reward fits the server's limits. Pick places, items, NPCs and blocks with buttons ("here", "what I'm holding", "the next NPC I use"). Try it runs a test copy with no rewards; Save adds it to the Quest Log's Server quests tab.
Sample quests
Ten short quests, a few minutes each, in the Quest Log's Samples tab, each showing a handful of the building blocks: gathering and crafting, breaking and building, a hunt for hidden items, treasure, a fight with a branch if you fall, exploring underground and through a portal, talking and choosing, weather and moon, noticing, and a server-wide tally. Switch them off in the settings.
Quest packs
- Hytale Tutorial (Quest Pack 1): a Guide near the spawn point with short lessons for new players, and
/tutorial. It's built on Quest Generator, and shows what a quest pack looks like.
Install
- Install CommandDeck 1.3.0 or later, Generous Operator 1.1.0 or later and Mod Settings Manager 1.0.2 or later. The CurseForge app installs them for you.
- Optional: BuffEffects 1.0.1 or later for boons, and Hal's Mapper 1.0 or later for places, routes, map markers and cave treasure.
- Put the Quest Generator jar in your server's
modsfolder (singleplayer:%APPDATA%\Hytale\UserData\Mods\). - Start the server and type
/quest.
Commands and permissions
| Command | What it does |
|---|---|
/quest or /quest log |
Opens your Quest Log |
/quest start <quest> [player] [mode] |
Starts a quest: for you, or for a player you name. Shared quests start for the server |
/quest track [quest] |
Shows a quest on screen. track off <quest> takes it off; track count <1-3> sets how many you track |
/quest list [mod] |
Lists the loaded quests |
/quest status [player] |
Running quests and their steps |
/quest stop <quest> [player] |
Ends a running quest, as failed, and cleans up |
/quest reset <quest> [player] |
Forgets a player's run of a quest, so it can be taken again |
/quest giver place <giver> [here] and /quest giver remove <giver> |
Places a quest giver's NPC (near spawn, or where you stand), or takes it away |
/quest construct [quest] |
Opens the quest constructor, empty or on a quest saved from it |
/quest track most <1-3> |
The most quests anyone can track on screen |
/quest reload |
Reads the quest files again; running quests carry on |
/quest save |
Saves running quests now |
Every command is also a button in CommandDeck. A quest pack may add its own command name (a tutorial pack's /tutorial, say), which opens the Quest Log on that pack's quests.
Permissions: the Quest Log (with its Start buttons for your own quests), tracking, and /quest status for yourself are for everyone. The constructor needs hledjolf.questgenerator.constructor. /quest start, list, stop, reset, giver, track most, reload and save, and status for another player, need hledjolf.questgenerator.operator. Operators have everything. Operator actions are written to quests.log with the operator's name.
Settings
In Mod Settings Manager's window, with no restart:
- Sample quests: on or off.
- Hints: hint text under objectives, and greyed answers in dialogue. Off hides both.
- Map markers: the markers quests put on the map (drawn by Hal's Mapper).
Which mods may give rewards from the server, and how big, is Generous Operator's to decide, in its own settings.
Compatibility
- Hytale server 0.7.7, dedicated servers and singleplayer.
- Hard treasure hunts (written directions to a buried chest) are listed but greyed out: they come in a later version.
For mod authors
- Ship quests in your own mod: JSON files in your jar's
questgenerator/quests/folder (givers and game bindings sit beside them). Without Quest Generator installed, they're never read, so there's no dependency. A pack that's only data can go up as an asset pack, with no code at all. - The format is checked when it loads. A quest with a mistake is refused, with a log line naming the file, the quest and the problem. The rest still load.
- Rewards are Generous Operator kits, from your own catalog or anyone's.
- An API for mods with their own mechanics: read quest state, raise your own signals for steps to listen to, start your quests, register places, and feed in the day's holidays.
- The quest format, its JSON Schema and complete examples are in the source repository (
docs/), and MIT, like the rest.
On the drawing board
Ideas being worked on for later versions. No promises: what arrives, and when, depends on what the game allows and what holds up in testing.
- More objectives: dropping an item at a place (an offering at a shrine); landing an effect on something (with BuffEffects); being seen, or not seen, by an NPC; a full set of armour worn together.
- More gates: a condition that must hold at the moment of progress ("kill it at night"), standing with factions if the game has them, and settlements as places.
- Harder treasure: written directions to a chest buried under a mark, with the player's own notes.
- Longer stories: acts, clues and leads, givers whose motives aren't what they say, and markers on NPCs who move.
- Rewards sized to the quest: materials drawn at random, worth about what the same time spent mining would earn.
- More constructor templates, more of the format reachable from the window, and opening any quest (the samples, or another pack's) as a starting point.
License
MIT. Bundling it in a modpack is fine: keep the license with it.
Source and issues: https://github.com/Hledjolf/QuestGenerator




