Quest Assignment
Quest Assignment to Category
Assigns quests to a category with optional per-quest display overrides. Multiple entries can reference the same category to add more quests. Quest order is controlled via [orders] (aligned with [questRefs]). Example: quest_assignment: category: "main_quests" quest_refs: - "quest:the_beginning" - "quest:the_journey" orders: [0, 1] not_started_item: PAPER in_progress_item: CLOCK completed_item: EMERALD
Fields
| Field | Type | Default | Description |
|---|---|---|---|
category | String | — | Category to assign quests to. |
questRefs | List<Ref<QuestEntry>> | empty | Quests to assign to this category. |
orders | List<Int> | empty | Display order for each quest, aligned index-by-index with questRefs. Lower numbers appear first. Optional: leave it empty and quests keep the order you listed them in. Ordered quests always come before unordered ones, and the order is the same for every player. |
notStartedItem | Item? | — | Override: item shown when the quest has not started. |
inProgressItem | Item? | — | Override: item shown when the quest is in progress. |
completedItem | Item? | — | Override: item shown when the quest is completed. |
notStartedName | String | — | Override: name shown when the quest has not started.PlaceholdersColors |
inProgressName | String | — | Override: name shown when the quest is in progress.PlaceholdersColors |
completedName | String | — | Override: name shown when the quest is completed.PlaceholdersColors |
notStartedLore | String | — | Override: additional lore when the quest has not started.PlaceholdersColorsMulti-line |
inProgressLore | String | — | Override: additional lore when the quest is in progress.PlaceholdersColorsMulti-line |
completedLore | String | — | Override: additional lore when the quest is completed.PlaceholdersColorsMulti-line |
hideWhenNotStarted | Boolean | false | Hide this quest while not started. |
hideWhenInProgress | Boolean | false | Hide this quest while in progress. |
hideWhenCompleted | Boolean | false | Hide this quest when completed. |
hideObjectivesWhenInProgress | Boolean | false | Hide objectives while in progress. |
hideObjectivesWhenCompleted | Boolean | false | Hide objectives when completed. |
How to use it
List quests of the official Quest extension in questRefs and give them a category. Several assignments can target the same category; their lists and overrides are merged.
ordersis optional and aligned withquestRefsby position. Ordered quests come first, the others keep their listed order.- The
...Item,...Nameand...Lorefields override how a quest looks while it is not started, in progress or completed. Left empty, the codex uses a book, a clock or an emerald, the quest name, and the lore from Quest Lore. hideWhen...hides the quest in that status.hideObjectivesWhen...hides its objectives.