Skip to main content
forge-quests runs quests: accept, progress through stages and objectives, turn in, and reward. Objectives are event-driven, riding on the events other packages already fire (kills, collects, interacts, casts). It also includes a minimal server-authoritative dialogue system.

​
Concepts

  • Quest. A stable quest:<name> with stages, each holding objectives. Optional autoTurnIn, repeatable, and rewards.
  • Objective kinds. kill, collect, interact, cast, reach, talk, custom. They match on events, so no polling.
  • Dialogue. A dlg:<name> node tree whose choices can accept quests, gated by quest state.

​
Exports

​
Registry

ExportSignature
RegisterQuest / RegisterQuestsregister quest definitions
RegisterDialogue / RegisterDialoguesregister dialogue trees

​
Progress

ExportSignatureReturns
AcceptQuestAcceptQuest(character_id, quest_id)Result
AbandonQuest / FailQuest / TurnInQueststate transitions
GetQuestLogGetQuestLog(character_id)Result{ data = { quests } }
GetQuestStateGetQuestState(character_id, quest_id)Result
AdvanceObjectiveAdvanceObjective(character_id, quest_id, objective_id, n)manual progress for custom objectives

​
Dialogue

ExportSignature
StartDialogueStartDialogue(character_id, { dialogue }), the canonical interaction outcome handler
ChooseDialogueOptionChooseDialogueOption(character_id, choice)
EndDialogueEndDialogue(character_id)

​
Quest shape

exports["forge-quests"]:RegisterQuest({
  id = "quest:first_lesson", label = "The First Lesson", category = "lesson",
  autoTurnIn = true,
  repeatable = { reset = 0 },
  stages = {
    { label = "Trial", objectives = {
      { id = "slay", kind = "kill", archetype = "npc:training_dummy", count = 3 },
    } },
  },
  rewards = { xp = { amount = 150 } },
})

​
Events

EventPayload
forge-quests:server:accepted{ character_id, quest_id }
forge-quests:server:objectiveProgress{ character_id, quest_id, count, target }
forge-quests:server:stageCompleted{ character_id, quest_id }
forge-quests:server:turnedIn{ character_id, quest_id }
forge-quests:server:failed / abandonedquest outcomes

​
Configuration

forge-quests ships no content; quests and dialogue are creator-defined. Config.Rules caps active quests; Config.Reach tunes the proximity poll for reach objectives.