Quest Framework

This mod is meant to serve as a means of implementing quests of all sorts in Valheim.

For an example of how it works, see:

• []Haldor Quests

  []Hugin Quests

  This mod has two basic functions - displaying quests and organizing quests.

  Displaying Quests

  Quests can have names and descriptions; each quest stage can have a name and a description; and each objective in a stage can have a name and a description.

  The config has templates for displaying each of these, as well has the main header of the display. If a quest doesn't have a given field, that template will be ignored.

  Templates accept rich text tags like <color=#xxxxxx>, <b>, <i>, <size=xx>.

  The display can be toggled using a custom hotkey (default j). It can be moved around by dragging with the mouse.

  Organizing Quests

  If you are not a modder, you can skip this section.

  Basically, mods implement their own quest functionality, relying on this mod to tell them which quests a player has, and what is the state of those quests.  Quest info is saved in BepInEx\plugins\QuestFramework\ as binary files for each player_world combination.

  Quest Manipulation

  Set this mod's dll as a dependency for your mod and use the QuestFrameworkAPI class to access the current player's quests.

  • []GetCurrentQuests() gets a Dictionary of the quests with the quest ids as keys.

    []GetQuestByID(string ID) gets the quest specified by the ID or null if it is not active for the player.

    []AddQuest(QuestData qd, bool force = false) adds a quest. To update an existing quest, force must be true.  Returns true if successful.

    []RemoveQuest(string ID) removes a quest from the player's quests. Returns true if successful.

    []IsQuestActive(string ID) returns true if the quest is active for the local player.

    []ChangeStage(string questID, string stageID) sets the current stage for a specified quest. Returns true if successful.

    []GetCurrentStage(string questID) returns the current stage ID for a specified quest.

    You can also access this mod's quest dictionary directly at QuestFramework. BepInExPlugin.currentQuests.questDict.

    Quest Format

    Use the QuestFramework. QuestData class to submit quests to the mod.

    []string QuestData.name

    []string QuestData.desc

    []string QuestData. ID - the unique id for the quest

    []string QuestData.currentStage

    []Dictionary<string, object> QuestData.data - an arbitrary s