Skip to main content

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

FieldTypeDefaultDescription
categoryString—Category to assign quests to.
questRefsList<Ref<QuestEntry>>emptyQuests to assign to this category.
ordersList<Int>emptyDisplay 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.
notStartedItemItem?—Override: item shown when the quest has not started.
inProgressItemItem?—Override: item shown when the quest is in progress.
completedItemItem?—Override: item shown when the quest is completed.
notStartedNameString—Override: name shown when the quest has not started.PlaceholdersColors
inProgressNameString—Override: name shown when the quest is in progress.PlaceholdersColors
completedNameString—Override: name shown when the quest is completed.PlaceholdersColors
notStartedLoreString—Override: additional lore when the quest has not started.PlaceholdersColorsMulti-line
inProgressLoreString—Override: additional lore when the quest is in progress.PlaceholdersColorsMulti-line
completedLoreString—Override: additional lore when the quest is completed.PlaceholdersColorsMulti-line
hideWhenNotStartedBooleanfalseHide this quest while not started.
hideWhenInProgressBooleanfalseHide this quest while in progress.
hideWhenCompletedBooleanfalseHide this quest when completed.
hideObjectivesWhenInProgressBooleanfalseHide objectives while in progress.
hideObjectivesWhenCompletedBooleanfalseHide 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.

  • orders is optional and aligned with questRefs by position. Ordered quests come first, the others keep their listed order.
  • The ...Item, ...Name and ...Lore fields 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.