Skip to main content
Links QuestExtension quests to a category defined by Quest Category. Multiple assignment entries can reference the same category to add more quests.

​
Fields

FieldTypeDefaultDescription
categoryString""Category to assign quests to (must match a quest_category entry).
questRefsList<Ref<QuestEntry>>[]Quest entries to assign. Reference QuestExtension quests.
ordersList<Int>[]Display order for each quest (aligned with questRefs). Lower = first.

​
Per-Status Overrides

Each quest can have custom display fields per status:
FieldTypeDescription
notStartedItemItem @ContentEditorCustom item when the quest has not started.
inProgressItemItem @ContentEditorCustom item when the quest is in progress.
completedItemItem @ContentEditorCustom item when the quest is completed.
notStartedNameString @Placeholder @ColoredCustom name when not started.
inProgressNameString @Placeholder @ColoredCustom name when in progress.
completedNameString @Placeholder @ColoredCustom name when completed.
notStartedLoreString @Placeholder @Colored @MultiLineAdditional lore when not started.
inProgressLoreString @Placeholder @Colored @MultiLineAdditional lore when in progress.
completedLoreString @Placeholder @Colored @MultiLineAdditional lore when completed.

​
Visibility

FieldTypeDefaultDescription
hideWhenNotStartedBooleanfalseHide this quest while not started.
hideWhenInProgressBooleanfalseHide this quest while in progress.
hideWhenCompletedBooleanfalseHide this quest when completed.
hideObjectivesWhenInProgressBooleanfalseHide objective progress while in progress.
hideObjectivesWhenCompletedBooleanfalseHide objective progress when completed.

​
Example

{
  "type": "quest_assignment",
  "id": "assign_main",
  "name": "Main Story Quests",
  "category": "main_quests",
  "questRefs": ["quest:quest_main_1", "quest:quest_main_2"],
  "orders": [0, 1],
  "notStartedName": "",
  "inProgressName": "",
  "completedName": "",
  "hideWhenNotStarted": false,
  "hideWhenInProgress": false,
  "hideWhenCompleted": false
}

​
Quest Ref Format

questRefs uses Typewriter’s ref system. Reference quests from QuestExtension: 
questRefs: ["quest:quest_main_1", "quest:quest_main_2"]
Each ref points to a QuestEntry defined via QuestExtension. The quest must exist in a compiled page for the assignment to work.