Add invitePriorityQuest trigger

automations/invitePriorityQuest.gs

@@ -0,0 +1,160 @@
+/**
+ * invitePriorityQuest()
+ *
+ * Chooses the quest scroll with the lowest party completion percentage
+ * from the player's inventory and invites their party to the quest.
+ * If EXCLUDE_GEM_QUESTS = true, gem quest scrolls are ignored.
+ * If EXCLUDE_HOURGLASS_QUESTS = true, hourglass quest scrolls are ignored.
+ *
+ * Run this function 5-15 mins after the party finishes a quest. The
+ * randomized delay allows party members without scripts to run quests
+ * too, and prevents multiple "invite quest" requests from hitting
+ * Habitica's servers at once.
+ */
+function invitePriorityQuest() {
+  try {
+    // delete temporary trigger
+    for (let trigger of ScriptApp.getProjectTriggers()) {
+      if (trigger.getHandlerFunction() === "invitePriorityQuest") {
+        ScriptApp.deleteTrigger(trigger);
+      }
+    }
+
+    // if not in a party or party is on a quest, return
+    if (
+      typeof getParty(true) === "undefined" ||
+      typeof party.quest.key !== "undefined"
+    ) {
+      return;
+    }
+
+    // get quest completion data for the party
+    let questCompletionData = getQuestCompletionData();
+
+    // for each quest scroll the player owns
+    let availableQuests = [];
+    for (let [questKey, numScrolls] of Object.entries(getUser().items.quests)) {
+      if (numScrolls > 0) {
+        // if not excluded by settings
+        let category = getContent().quests[questKey].category;
+        if (
+          (AUTO_INVITE_HOURGLASS_QUESTS === true &&
+            category === "timeTravelers") ||
+          (category != "timeTravelers" &&
+            ((AUTO_INVITE_GOLD_QUESTS === true &&
+              typeof content.quests[questKey].goldValue !== "undefined") ||
+              (AUTO_INVITE_UNLOCKABLE_QUESTS === true &&
+                category === "unlockable") ||
+              (AUTO_INVITE_PET_QUESTS === true &&
+                ["pet", "hatchingPotion"].includes(category))))
+        ) {
+          // find the quest in completion data
+          let questCompletion = questCompletionData.find(
+            (q) => q.questKey === questKey
+          );
+
+          if (questCompletion) {
+            availableQuests.push({
+              questKey: questKey,
+              numScrolls: numScrolls,
+              completionPercentage: questCompletion.completionPercentage,
+              questName: content.quests[questKey].text,
+            });
+          } else {
+            // quest not found in completion data (e.g., world boss), add with 0% completion
+            availableQuests.push({
+              questKey: questKey,
+              numScrolls: numScrolls,
+              completionPercentage: 0,
+              questName: content.quests[questKey].text,
+            });
+          }
+        }
+      }
+    }
+
+    // log all quests with completion percentages (for debugging)
+    let userQuestScrolls = new Set(
+      Object.keys(getUser().items.quests).filter(
+        (q) => getUser().items.quests[q] > 0
+      )
+    );
+
+    // sort all quest completion data by percentage
+    questCompletionData.sort(
+      (a, b) => a.completionPercentage - b.completionPercentage
+    );
+
+    console.log("=== Quest Completion Data (sorted by %) ===");
+    for (let quest of questCompletionData) {
+      let hasScroll = userQuestScrolls.has(quest.questKey) ? " *" : "";
+      console.log(
+        Math.floor(quest.completionPercentage).toString().padStart(3) +
+          "% - " +
+          quest.questName +
+          hasScroll
+      );
+    }
+    console.log("(* = you have a scroll for this quest)");
+    console.log("==========================================");
+
+    // if list contains scrolls
+    if (availableQuests.length > 0) {
+      // sort by completion percentage (lowest first)
+      availableQuests.sort(
+        (a, b) => a.completionPercentage - b.completionPercentage
+      );
+
+      // select the quest with the lowest completion percentage
+      let selectedQuest = availableQuests[0];
+
+      console.log(
+        "Selected: " +
+          selectedQuest.questName +
+          " (completion: " +
+          Math.floor(selectedQuest.completionPercentage) +
+          "%)"
+      );
+
+      // invite party to the selected quest
+      fetch(
+        "https://habitica.com/api/v3/groups/party/quests/invite/" +
+          selectedQuest.questKey,
+        POST_PARAMS
+      );
+
+      scriptProperties.deleteProperty("QUEST_SCROLL_PM_SENT");
+    }
+
+    // send player a PM if they are out of usable quest scrolls
+    if (
+      PM_WHEN_OUT_OF_QUEST_SCROLLS === true &&
+      availableQuests.length <= 1 &&
+      scriptProperties.getProperty("QUEST_SCROLL_PM_SENT") === null
+    ) {
+      console.log("No more usable quest scrolls, sending PM to player");
+
+      let params = Object.assign(
+        {
+          contentType: "application/json",
+          payload: JSON.stringify({
+            message: "You have no more usable quest scrolls!",
+            toUserId: USER_ID,
+          }),
+        },
+        POST_PARAMS
+      );
+      fetch("https://habitica.com/api/v3/members/send-private-message", params);
+
+      scriptProperties.setProperty("QUEST_SCROLL_PM_SENT", "true");
+    }
+  } catch (e) {
+    MailApp.sendEmail(
+      Session.getEffectiveUser().getEmail(),
+      DriveApp.getFileById(ScriptApp.getScriptId()).getName() + " failed!",
+      e.stack
+    );
+    console.error(e.stack);
+    throw e;
+  }
+}