Reference¶

Controls¶

Key	Action
K	Opens the quest book
G	Shows or hides each quest's steps in the HUD

File config/questmod-client.toml.

Option	Default	Description
`hud.enabled`	`true`	Shows the progress of active quests on screen
`hud.side`	`LEFT`	HUD side: `LEFT` or `RIGHT`
`hud.maxQuests`	`5`	Maximum quests shown in the HUD (1 to 10)
`hud.expanded`	`false`	Shows each quest's steps separately (toggled with the G key)
`npc.allowUrlSkins`	`true`	Allows downloading skins from https links set on NPCs by the server
`npc.showNpcMarker`	`true`	Shows the `!` above NPCs

File serverconfig/questmod-server.toml of each world (or defaultconfigs/questmod-server.toml to set values in a modpack).

Option	Default	Description
`general.adminPermissionLevel`	`2`	Op level needed to manage quests and NPCs (0 to 4)
`general.singleplayerOwnerIsAdmin`	`true`	In a singleplayer world, the owner is an admin even without cheats
`general.bookEnabled`	`true`	Enables the quest book (key and item)
`general.giveBook`	`FIRST_JOIN`	When the book is given: `NEVER`, `FIRST_JOIN` (once per player) or `IF_MISSING` (on every join, if not carrying one)

For admins (the configured level, 2 by default; the console and command blocks use that same level).

Command	What it does
`/questmod export <namespace>`	Exports the world's quests and sections as a datapack in `questmod_export/<namespace>/`
`/questmod reset <players> [quest]`	Resets all progress, or a single quest
`/questmod complete <players> <quest>`	Marks a quest as completed
`/questmod community reset <quest>`	Resets a community quest for everyone (counter, contributions and claimed rewards)

Use the usual /reload to reload datapack quests.

ID	What it is
`questmod:quest_npc`	The Quest Master (`/summon questmod:quest_npc`)
`questmod:quest_npc_spawn_egg`	Its spawn egg
`questmod:quest_scroll`	Quest scroll (copies and pastes lists between NPCs)
`questmod:quest_book`	Quest book (opens the panel without an NPC)

Path	Content
`data/<ns>/questmod/quests/*.json`	Quests
`data/<ns>/questmod/sections/*.json`	Sections

The formats are in Modpacks and datapacks and there are JSON schemas to validate them.

All of this is changed with assets/questmod/theme.json (see Theming). This table was generated by reading the mod's code.

Key	Default	Use
`panel`	`E0141418`	Panel background
`title`	`E8C34A`	Titles
`accent`	`E8C34A`	Accents (selected tab, objectives)
`text`	`FFFFFF`	Main text
`text_dim`	`9A9AA5`	Secondary text
`text_muted`	`888888`	Muted text (hints)
`tab_hover_line`	`666666`	Tab underline
`error`	`FF5555`	Error messages
`entry`	`1B1B24`	Row background
`entry_hover`	`23232E`	Row under the mouse
`entry_selected`	`2D2D44`	Selected row
`claimed`	`7DEB7D`	"Done" / claimed text
`bar_bg`	`33333D`	Bar background
`bar_fill`	`5B8DD9`	Progress bar fill
`bar_done`	`4CAF50`	Completed bar
`btn_accept`	`2E7D32`	Accept button
`btn_claim`	`8A6D1B`	Claim button
`btn_edit`	`2A4B6B`	Edit button
`btn_delete`	`6B2A2A`	Delete button
`btn_confirm`	`8A1B1B`	Confirm button
`btn_disabled`	`3A3A3A`	Disabled button
`btn_neutral`	`3F3F48`	Neutral button
`btn_text_disabled`	`777777`	Disabled button text
`btn_text_confirm`	`FF8888`	Confirm button text
`hud_bg`	`B0141418`	HUD box background

Key	Default	Use
`panel_width`	`460`	Maximum width of the quest panel
`list_width`	`170`	Width of the quest list
`entry_height`	`72`	Height of a quest row
`entry_height_compact`	`60`	Row height in compact mode
`hud_width`	`152`	Minimum HUD width
`hud_max_width`	`240`	Maximum HUD width
`entry_stripe`	`3`	Width of the row status stripe (0 hides it)