Quest Codex

Quest Codex Global Settings

ManifestProvided by Quest Codex

Fields

Field	Type	Default	Description
soundOnOpen	Sound	—	Sound played when a menu is opened.
soundOnSwitch	Sound	—	Sound played when switching between categories/menus.
soundOnClick	Sound	—	Sound played when clicking a navigation button.
soundOnTrack	Sound	—	Sound played when tracking a quest.
soundOnUntrack	Sound	—	Sound played when untracking a quest.
defaultRows	Int	4	Default number of inventory rows for category menus (3-6).
multiTrackingEnabled	Boolean	true	Allow QuestCodex to track several active quests while the official Quest tracker displays the most recently selected one.
maxTrackedQuests	Int	5	Maximum number of quests tracked simultaneously by QuestCodex.
trackingArtifact	Ref<QuestCodexTrackingArtifactEntry>	—	Artifact used to persist each player's tracked quest ids and their tracking order.
recoveryEnabled	Boolean	true	Enable safe recovery of active Typewriter dialogues and cinematics after a disconnect.
recoveryArtifact	Ref<QuestCodexRecoveryArtifactEntry>	—	Artifact used to persist active dialogue and cinematic recovery snapshots.
recoveryRetentionSeconds	Long	120	How long an interrupted interaction remains restorable, in seconds.
recoveryRestoreDelayTicks	Long	2	Ticks to wait after join before restoring an interrupted interaction.
nowTrackingMessage	String	<green>Now tracking: {quest}</green>	Message shown when a player starts tracking a quest. Placeholders: {quest}PlaceholdersColors
stoppedTrackingMessage	String	<gray>No longer tracking: {quest}</gray>	Message shown when a player stops tracking a quest. Placeholders: {quest}PlaceholdersColors
questInactiveMessage	String	<gold>{quest} — Start this quest!</gold>	Message shown when clicking an inactive quest. Placeholders: {quest}PlaceholdersColors
questCompletedMessage	String	<green>{quest} — Completed!</green>	Message shown when clicking a completed quest. Placeholders: {quest}PlaceholdersColors
categoryProgressMessage	String	<gray>{completed}/{total} quests</gray>	Lore line showing category progress. Placeholders: {completed}, {total}PlaceholdersColors
categoryClickHint	String	<yellow>Click to view quests</yellow>	Lore hint telling the player to click to see quests.PlaceholdersColors
questTrackHint	String	<yellow>Click to track</yellow>	Lore hint telling the player to click to track/un-track this quest.PlaceholdersColors
questUntrackHint	String	<yellow>Click to stop tracking</yellow>	Lore hint shown for a quest already tracked by QuestCodex.PlaceholdersColors
trackingLimitMessage	String	<red>You can track at most {max} quests.</red>	Message shown when the simultaneous tracking limit is reached. Placeholder: {max}.PlaceholdersColors
mainMenuTrigger	Ref<TriggerableEntry>	—	Entry triggered to open the main menu (e.g. an open_gui entry) when no category_menu with an empty category exists. Used by /tw codex and the BACK button.
navLabels	CodexNavLabels	—	Labels of the built-in navigation buttons (next, previous, scroll, back, close, sort), shown when their slot has no configured item. CodexNavLabels (9) Field Type Default Description next String <yellow>Next Label of the next page button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors previous String <yellow>Previous Label of the previous page button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors up String <white>Up Label of the scroll up button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors down String <white>Down Label of the scroll down button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors left String <white>Left Label of the scroll left button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors right String <white>Right Label of the scroll right button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors back String <red>Back Label of the back button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors close String <red>Close Label of the close button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors sort String <yellow>Sort Label of the sort button, shown when its slot has no configured item. Supports MiniMessage.PlaceholdersColors
sortTexts	CodexSortTexts	—	Texts of the sort button, used when the category menu does not set its own for the active sort mode. CodexSortTexts (5) Field Type Default Description allLabel String <yellow>📋 All quests Sort button label while every quest is listed. Supports MiniMessage.PlaceholdersColors notStartedLabel String <white>📋 Not started Sort button label while only the quests not started are listed. Supports MiniMessage.PlaceholdersColors activeLabel String <green>📋 In progress Sort button label while only the quests in progress are listed. Supports MiniMessage.PlaceholdersColors completedLabel String <gray>📋 Completed Sort button label while only the completed quests are listed. Supports MiniMessage.PlaceholdersColors hint String <gray>Click to change sorting Lore line of the sort button telling the player a click changes the sorting. Supports MiniMessage.PlaceholdersColors
mainMenuTitle	String	<dark_gray>Quest Codex	Title of the main menu when its category_menu entry has no title.PlaceholdersColors
trackedQuestsTitle	String	<gold>Tracked quests	Title of the tracked quests menu when its category_menu entry has no title.PlaceholdersColors
unknownCategoryMessage	String	Unknown category: {category}	Error shown when a player runs /tw codex with a category that does not exist. Supports MiniMessage. Placeholders: {category}Colors

How to use it

Create one of these entries. Without it every option uses its default.

• Reference a Quest Codex Tracking Data entry in trackingArtifact, otherwise tracked quests are lost on restart.
• multiTrackingEnabled off makes tracking a new quest replace the previous one. maxTrackedQuests caps the list, and the oldest are dropped if you lower it.
• recoveryEnabled needs a Quest Codex Recovery Data entry in recoveryArtifact.
• mainMenuTrigger is fired by /tw codex and by the BACK button when no Category Menu with an empty category exists.

See Configuration for the full list.