osrs-tools 2.7.0 → 2.8.0

package/dist/runescape/model/clue/ClueScrollHelper.js

@@ -5,7 +5,10 @@
  * WIKI REFERENCE: https://oldschool.runescape.wiki/w/Clue_scrolls
  * Each tier has unique mechanics documented in the reward casket pages
  */
-import { getClueRewardsByTier, getClueRewardTables } from "./ClueScrollRewards";
+import { getClueRewardsByTier, getClueRewardTables, ELITE_REWARDS, MASTER_REWARDS } from "./ClueScrollRewards";
+const ELITE_MIMIC_BASE_CHANCE = 1 / 35;
+const ELITE_MIMIC_GUARANTEE_STREAK = 25;
+let eliteCasketsSinceMimic = 0;
 //======================================================================================
 // CORE UTILITY METHODS - Weighted Selection
 //======================================================================================
@@ -253,28 +256,87 @@ function openHardCasket() {
 function openEliteCasket() {
     const rewardCount = getEliteRewardCount();
     const rewards = [];
-    const tables = getClueRewardTables("elite");
-    // Main rewards
+    const uniqueTable = ELITE_REWARDS.tables.find((t) => t.name === "unique")?.items;
+    const standardTable = ELITE_REWARDS.tables.find((t) => t.name === "standard")?.items;
+    const megaRareTable = ELITE_REWARDS.tables.find((t) => t.name === "mega-rare")?.items;
+    const masterBonusTable = ELITE_REWARDS.tables.find((t) => t.name === "master")?.items;
+    if (!uniqueTable || !standardTable || !megaRareTable) {
+        throw new Error("Elite reward tables are missing required unique/standard/mega-rare entries.");
+    }
+    // Main rewards (4-6): explicit hierarchy per roll.
     for (let i = 0; i < rewardCount; i++) {
-        const selectedTable = selectWeightedTable(tables);
-        const item = selectRandomReward(selectedTable);
-        rewards.push(item);
+        rewards.push(generateElitePrimaryRoll(uniqueTable, standardTable, megaRareTable));
+    }
+    const mimicGuaranteed = eliteCasketsSinceMimic >= ELITE_MIMIC_GUARANTEE_STREAK - 1;
+    const mimicTriggered = mimicGuaranteed || Math.random() < ELITE_MIMIC_BASE_CHANCE;
+    if (mimicTriggered) {
+        eliteCasketsSinceMimic = 0;
+    }
+    else {
+        eliteCasketsSinceMimic += 1;
     }
     // Master clue: 1/5 chance (20%), DOES NOT consume a slot
     const masterClueRoll = Math.random();
     let masterClue;
     if (masterClueRoll < 1 / 5) {
-        const masterTable = tables.find((t) => t.weight === 0 && "items" in t);
-        if (masterTable && "Clue scroll (master)" in masterTable.items) {
-            masterClue = masterTable.items["Clue scroll (master)"].item;
+        if (masterBonusTable && "Clue scroll (master)" in masterBonusTable) {
+            masterClue = masterBonusTable["Clue scroll (master)"].item;
         }
     }
-    const result = { items: rewards, count: rewardCount };
+    // Pity roll behavior is not fully public; this simulation uses a conservative
+    // threshold + proc chance to emulate the documented mechanic.
+    const result = {
+        items: rewards,
+        count: rewardCount,
+        mimicTriggered,
+        mimicGuaranteed: mimicTriggered ? mimicGuaranteed : undefined,
+    };
     if (masterClue) {
         result.masterClue = masterClue;
     }
     return result;
 }
+function generateElitePrimaryRoll(uniqueTable, standardTable, megaRareTable) {
+    // Elite mega-rare gate per roll.
+    if (Math.random() < 1 / 13616) {
+        return selectEliteMegaRareWithThirdAgeWeaponsBias(megaRareTable);
+    }
+    // Elite uniques are roughly 1/14 per roll.
+    if (Math.random() < 1 / 14) {
+        return selectRandomReward(uniqueTable);
+    }
+    // Default fallback.
+    return selectRandomReward(standardTable);
+}
+function selectEliteMegaRareWithThirdAgeWeaponsBias(megaRareTable) {
+    const weightedItems = [];
+    let totalWeight = 0;
+    for (const [name, { item, rarity }] of Object.entries(megaRareTable)) {
+        const key = name.toLowerCase();
+        const isDruidic = key.includes("druidic");
+        const isEliteFavoredThirdAge = key.includes("3rd age longsword") || key.includes("3rd age bow") || key.includes("3rd age cloak") || key.includes("3rd age wand");
+        // Elite tables emphasize 3rd age weapon/cloak outcomes and do not include druidic pieces.
+        if (isDruidic) {
+            continue;
+        }
+        const baseWeight = 1 / rarity;
+        const boostedWeight = isEliteFavoredThirdAge ? baseWeight * 2 : baseWeight;
+        weightedItems.push({ item, weight: boostedWeight });
+        totalWeight += boostedWeight;
+    }
+    if (weightedItems.length === 0) {
+        return selectRandomReward(megaRareTable);
+    }
+    const roll = Math.random() * totalWeight;
+    let cumulative = 0;
+    for (const candidate of weightedItems) {
+        cumulative += candidate.weight;
+        if (roll < cumulative) {
+            return candidate.item;
+        }
+    }
+    return weightedItems[weightedItems.length - 1].item;
+}
 /**
  * Master casket opening
  * Standard weighted table selection with no special mechanics
@@ -284,13 +346,76 @@ function openEliteCasket() {
 function openMasterCasket() {
     const rewardCount = getMasterRewardCount();
     const rewards = [];
-    const tables = getClueRewardTables("master");
+    // Master casket hierarchy modeled from OSRS behavior:
+    // 1) Mega-rare gate
+    // 2) Unique gate
+    // 3) Standard fallback
+    const uniqueTable = MASTER_REWARDS.tables.find((t) => t.name === "unique")?.items;
+    const standardTable = MASTER_REWARDS.tables.find((t) => t.name === "standard")?.items;
+    const megaRareTable = MASTER_REWARDS.tables.find((t) => t.name === "mega-rare")?.items;
+    if (!uniqueTable || !standardTable || !megaRareTable) {
+        throw new Error("Master reward tables are missing required unique/standard/mega-rare entries.");
+    }
     for (let i = 0; i < rewardCount; i++) {
-        const selectedTable = selectWeightedTable(tables);
-        const item = selectRandomReward(selectedTable);
-        rewards.push(item);
+        rewards.push(generateMasterPrimaryRoll(uniqueTable, standardTable, megaRareTable));
     }
-    return { items: rewards, count: rewardCount };
+    // Mimic encounter: 1/15 chance per casket opening.
+    // Defeating mimic grants one extra roll with improved 3rd-age odds.
+    const mimicTriggered = Math.random() < 1 / 15;
+    if (!mimicTriggered) {
+        return { items: rewards, count: rewardCount };
+    }
+    const mimicBonusItem = generateMasterMimicBonusRoll(uniqueTable, standardTable, megaRareTable);
+    rewards.push(mimicBonusItem);
+    return {
+        items: rewards,
+        count: rewardCount,
+        mimicTriggered: true,
+        mimicBonusItem,
+    };
+}
+function generateMasterPrimaryRoll(uniqueTable, standardTable, megaRareTable) {
+    // Mega-rare table gate per-roll.
+    if (Math.random() < 1 / 13616) {
+        return selectRandomReward(megaRareTable);
+    }
+    // Master unique table is approximately 1/10 per roll.
+    if (Math.random() < 0.1) {
+        return selectRandomReward(uniqueTable);
+    }
+    // Default fallback.
+    return selectRandomReward(standardTable);
+}
+function generateMasterMimicBonusRoll(uniqueTable, standardTable, megaRareTable) {
+    // Mimic bonus roll has boosted mega-rare access.
+    if (Math.random() < 1 / 6808) {
+        return selectMasterMegaRareWithThirdAgeBoost(megaRareTable);
+    }
+    // Keep the same unique/common hierarchy for non-mega outcomes.
+    if (Math.random() < 0.1) {
+        return selectRandomReward(uniqueTable);
+    }
+    return selectRandomReward(standardTable);
+}
+function selectMasterMegaRareWithThirdAgeBoost(megaRareTable) {
+    const weightedItems = [];
+    let totalWeight = 0;
+    for (const [name, { item, rarity }] of Object.entries(megaRareTable)) {
+        const baseWeight = 1 / rarity;
+        const isThirdAge = name.toLowerCase().includes("3rd age");
+        const boostedWeight = isThirdAge ? baseWeight * 2 : baseWeight;
+        weightedItems.push({ item, weight: boostedWeight });
+        totalWeight += boostedWeight;
+    }
+    const roll = Math.random() * totalWeight;
+    let cumulative = 0;
+    for (const candidate of weightedItems) {
+        cumulative += candidate.weight;
+        if (roll < cumulative) {
+            return candidate.item;
+        }
+    }
+    return weightedItems[weightedItems.length - 1].item;
 }
 //======================================================================================
 // PUBLIC API
@@ -299,6 +424,12 @@ function openMasterCasket() {
  * Main ClueScrollHelper class that provides methods to simulate clue scroll rewards
  */
 export class ClueScrollHelper {
+    /**
+     * Resets internal simulation counters used for pity/guaranteed mechanics.
+     */
+    static resetSimulationState() {
+        eliteCasketsSinceMimic = 0;
+    }
     /**
      * Simulate opening a clue casket and return all rewards
      *

package/dist/runescape/model/clue/ClueScrollRewards.d.ts

@@ -3,7 +3,7 @@
  * Organizes all clue scroll rewards by tier with their correct rarity tiers
  * Based on official OSRS Wiki data
  */
-import { Item } from '../Item/Item';
+import { Item } from "../Item/Item";
 /**
  * Reward odds mapping for Beginner clue scrolls
  * Beginner caskets have a three-tier table structure based on wiki data:
@@ -126,6 +126,20 @@ export declare const ELITE_REWARDS: {
         };
     };
 };
+/**
+ * Master tier unique items
+ * Major rare table at various rarities (1/851 to 1/25,530)
+ */
+export declare const MASTER_UNIQUE_ITEMS: RewardTable;
+/**
+ * Master tier standard table
+ * Dragon weapons, runes, food, resources at 1/30.3 base
+ */
+export declare const MASTER_STANDARD_TABLE: RewardTable;
+/**
+ * Master tier mega-rare items (gilded + 3rd age + special)
+ */
+export declare const MASTER_MEGA_RARE_ITEMS: RewardTable;
 /**
  * Master clue rewards with table-based structure
  * 5-7 items per casket, average 6
@@ -147,7 +161,7 @@ export declare const MASTER_REWARDS: {
 /**
  * Gets all reward odds for a specific clue tier
  */
-export declare function getClueRewardsByTier(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): {
+export declare function getClueRewardsByTier(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): {
     [itemName: string]: {
         item: Item;
         rarity: number;
@@ -157,7 +171,7 @@ export declare function getClueRewardsByTier(tier: 'beginner' | 'easy' | 'medium
  * Gets the table structure for a specific clue tier (if available)
  * Returns null for tiers that don't have table-based rewards
  */
-export declare function getClueRewardTables(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): Array<{
+export declare function getClueRewardTables(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): Array<{
     name: string;
     weight: number;
     items: {
@@ -170,6 +184,6 @@ export declare function getClueRewardTables(tier: 'beginner' | 'easy' | 'medium'
 /**
  * Gets all items for a specific tier as an array
  */
-export declare function getClueItemsList(tier: 'beginner' | 'easy' | 'medium' | 'hard' | 'elite' | 'master'): Item[];
+export declare function getClueItemsList(tier: "beginner" | "easy" | "medium" | "hard" | "elite" | "master"): Item[];
 export {};
 //# sourceMappingURL=ClueScrollRewards.d.ts.map

package/dist/runescape/model/clue/ClueScrollRewards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClueScrollRewards.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/clue/ClueScrollRewards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AA6GpC;;;;;;;;;;;;;;;;GAgBG;AAEH,UAAU,WAAW;IACnB,CAAC,QAAQ,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACpD;AAwHD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;YAuBtB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBA9J0B,IAAI;oBAAU,MAAM;;;CAsKjD,CAAC;AAoJF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY;YA0BlB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBAjW0B,IAAI;oBAAU,MAAM;;;CAyWjD,CAAC;AA0NF;;;GAGG;AACH,eAAO,MAAM,cAAc;YA0BpB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBAtmB0B,IAAI;oBAAU,MAAM;;;CA8mBjD,CAAC;AAiPF;;;GAGG;AACH,eAAO,MAAM,YAAY;YAgClB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBAx4B0B,IAAI;oBAAU,MAAM;;;CAi5BjD,CAAC;AAiNF;;;GAGG;AACH,eAAO,MAAM,aAAa;YAgCnB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBA3oC0B,IAAI;oBAAU,MAAM;;;CAopCjD,CAAC;AAwJF;;;GAGG;AACH,eAAO,MAAM,cAAc;YA0BpB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBA/0C0B,IAAI;oBAAU,MAAM;;;CAu1CjD,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GACjE;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAiBxD;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GACjE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,IAAI,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAAC,GAAG,IAAI,CAiB/G;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,EAAE,CAG3G"}
+{"version":3,"file":"ClueScrollRewards.d.ts","sourceRoot":"","sources":["../../../../source/runescape/model/clue/ClueScrollRewards.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAibpC;;;;;;;;;;;;;;;;GAgBG;AAEH,UAAU,WAAW;IACnB,CAAC,QAAQ,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACpD;AAwHD;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;YAuBtB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBA9J0B,IAAI;oBAAU,MAAM;;;CAsKjD,CAAC;AAoJF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY;YA0BlB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBAjW0B,IAAI;oBAAU,MAAM;;;CAyWjD,CAAC;AA0NF;;;GAGG;AACH,eAAO,MAAM,cAAc;YA0BpB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBAtmB0B,IAAI;oBAAU,MAAM;;;CA8mBjD,CAAC;AAiPF;;;GAGG;AACH,eAAO,MAAM,YAAY;YAgClB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBAx4B0B,IAAI;oBAAU,MAAM;;;CAi5BjD,CAAC;AAiNF;;;GAGG;AACH,eAAO,MAAM,aAAa;YAgCnB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBA3oC0B,IAAI;oBAAU,MAAM;;;CAopCjD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAgDjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,WAqBnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,WAiDpC,CAAC;AAiBF;;;GAGG;AACH,eAAO,MAAM,cAAc;YA0BpB,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,WAAW,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;;;kBA/0C0B,IAAI;oBAAU,MAAM;;;CAu1CjD,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG;IAAE,CAAC,QAAQ,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAiB/J;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GACjE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,IAAI,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAAC,GAAG,IAAI,CAiB/G;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,EAAE,CAG3G"}