osrs-tools 2.3.0 → 2.3.3

package/dist/out-tsc/source/runescape/model/quest/all/Wanted.js

@@ -0,0 +1,115 @@
+import { Skill } from '../../account/Skill';
+import { QuestRequirement } from "../../Requirement";
+import { QuestDifficulty, QuestLength } from "../enums";
+import { QuestStatus } from "../Quest";
+/**
+ * https://oldschool.runescape.wiki/w/Wanted!
+ *
+ * Start point	Map icon Speak to Sir Tiffy Cashien in Falador Park. Show on map
+Official difficulty	Intermediate
+Official length	Medium
+Description	A wanted man is on the loose. Can you track him down?
+Requirements
+a_squeezer
+
+Quest points 32 Quest points
+Completion of the following quests:
+Recruitment Drive
+Black Knights' Fortress
+Druidic Ritual
+The Lost Tribe
+Rune Mysteries
+Goblin Diplomacy
+Priest in Peril
+Enter the Abyss
+The ability to defeat a level 32 Black Knight.
+Items required
+10,000 coins, or:
+Law rune
+Enchanted gem (bought from a Slayer Master)
+Molten glass
+20 un-noted Rune essence or pure essence (you'll get them back)
+ The player must deliver all 20 rune essence at once
+Light source (Note: Candles, torches and oil lamps can cause swamp gas explosions if going off-route, and need a tinderbox to stay lit)
+[uncheck all]
+Recommended
+Combat level 15 Combat level
+Armour and some food.
+Stamina or energy potions.
+Fast travel to several locations that are always visited during the quest
+Falador (Falador teleport)
+Canifis (Kharyrll Teleport, Ectophial, Salve Graveyard Teleport, Fenkenstrain's Castle Teleport, Fairy Rings to CKS or Slayer Ring to the Slayer Tower)
+Champions' Guild and Varrock (Combat Bracelet, Chronicle or Varrock teleport)
+Lumbridge (Lumbridge teleport)
+Fast travel to several randomly chosen locations
+Ardougne (Ardougne teleport)
+Brimhaven (travel from Ardougne)
+Rellekka (Enchanted lyre or Fremennik sea boots, or House teleport if your house is in Rellekka)
+Castle Wars (Ring of Dueling)
+Al Kharid (Ring of Dueling)
+Musa Point (Amulet of Glory to Karamja)
+Draynor Village (Amulet of Glory)
+Tree Gnome Stronghold (Gnome Glider, Balloon Transport System, Spirit trees or Slayer Ring to Stronghold Slayer Cave)
+Goblin Village (walk from Falador)
+Yanille (Watchtower teleport)
+McGrubor's Wood (Combat Bracelet to Ranging Guild or Fairy Rings to ALS)
+Grave of Scorpius (Ourania Teleport, Spirit Tree to Battle of Khazard, or Ring of Dueling to Castle Wars)
+[uncheck all]
+Enemies to defeat
+Black Knight (level 32)
+Solus Dellagar
+Ironman concerns
+ The player must have 20 inventory spots to deliver all 20 rune essence at once. If the miniquest Enter the Abyss has been completed, the table in the rune shop may be used to hold rune essence from multiple trips to bring to the nearby chaos altar while inventory items are dropped without the worry of them despawning.
+
+ Rewards
+
+1 Quest points Quest point
+Slayer 5,000 Slayer experience
+Access to the armoury of the White Knights (White equipment)
+Required for completing
+ */
+const Wanted = {
+    age: "",
+    description: "A wanted man is on the loose. Can you track him down?",
+    difficulty: QuestDifficulty.Intermediate,
+    id: 0,
+    length: QuestLength.Medium,
+    members: true,
+    miniquest: false,
+    name: "Wanted!",
+    questPoints: 1,
+    recommendations: [
+        { name: "Combat", quantity: 15, type: "level" },
+        { name: "Armour and some food", type: "item" },
+        { name: "Stamina or energy potions", type: "item" },
+    ],
+    recommendedPrayers: [],
+    recommendedSkills: { Combat: 15 },
+    requirements: [
+        new QuestRequirement("Recruitment Drive"),
+        new QuestRequirement("Black Knights Fortress"),
+        new QuestRequirement("Druidic Ritual"),
+        new QuestRequirement("The Lost Tribe"),
+        new QuestRequirement("Rune Mysteries"),
+        new QuestRequirement("Goblin Diplomacy"),
+        new QuestRequirement("Priest in Peril"),
+        new QuestRequirement("Enter the Abyss"),
+    ],
+    rewards: {
+        areas: [],
+        experience: [{ amount: 5000, skill: Skill.Slayer }],
+        items: [],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 1,
+        unlocks: [{ description: "Access to the armoury of the White Knights (White equipment)" }],
+    },
+    series: "Temple Knight, #2",
+    shortName: "wanted",
+    startLocation: "Falador Park",
+    status: QuestStatus.NotStarted,
+    steps: [],
+    url: "https://oldschool.runescape.wiki/w/Wanted!",
+};
+export default Wanted;

package/dist/out-tsc/source/runescape/model/quest/all/Watchtower.js

@@ -0,0 +1,45 @@
+import { Skill } from "../../account/Skill";
+import { LevelRequirement } from "../../Requirement";
+import { QuestDifficulty, QuestLength } from "../enums";
+import { QuestStatus } from "../Quest";
+const Watchtower = {
+    age: "",
+    description: "",
+    difficulty: QuestDifficulty.Experienced,
+    id: 0,
+    length: QuestLength.Long,
+    members: true,
+    miniquest: false,
+    name: "Watchtower",
+    questPoints: 3,
+    recommendations: [],
+    recommendedPrayers: [],
+    recommendedSkills: {},
+    requirements: [
+        new LevelRequirement(Skill.Magic, 20, false),
+        new LevelRequirement(Skill.Herblore, 14, false),
+        new LevelRequirement(Skill.Defence, 40, false),
+        new LevelRequirement(Skill.Thieving, 15, false),
+    ],
+    rewards: {
+        areas: [],
+        experience: [
+            { amount: 6000, skill: Skill.Magic },
+            { amount: 6000, skill: Skill.Ranged },
+            { amount: 6000, skill: Skill.Strength },
+        ],
+        items: [],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 3,
+        unlocks: [],
+    },
+    series: null,
+    shortName: "watchtower",
+    startLocation: "",
+    status: QuestStatus.NotStarted,
+    steps: [],
+    url: "https://oldschool.runescape.wiki/w/Watchtower",
+};
+export default Watchtower;

package/dist/out-tsc/source/runescape/model/quest/all/WaterfallQuest.js

@@ -0,0 +1,46 @@
+import { QuestDifficulty, QuestLength } from '../enums';
+import { QuestStatus } from '../Quest';
+const WaterfallQuest = {
+    age: 'Third Age',
+    description: 'Help a tribesperson recover a sacred totem from a mysterious waterfall.',
+    difficulty: QuestDifficulty.Novice,
+    id: 0,
+    length: QuestLength.Medium,
+    members: true,
+    miniquest: false,
+    name: 'Waterfall Quest',
+    questPoints: 1,
+    recommendations: [],
+    recommendedPrayers: [],
+    recommendedSkills: { Agility: 10 },
+    requirements: [],
+    rewards: {
+        areas: ['Waterfall dungeon access'],
+        experience: [{ amount: 1000, skill: 'Attack' }, { amount: 1000, skill: 'Strength' }],
+        items: [],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 1,
+        unlocks: [
+            {
+                description: 'Access to Waterfall dungeon for training',
+                url: 'https://oldschool.runescape.wiki/w/Waterfall_Dungeon',
+            },
+        ],
+    },
+    series: null,
+    shortName: 'waterfallQuest',
+    startLocation: 'Arandar, east of Ardougne',
+    status: QuestStatus.NotStarted,
+    steps: [
+        'Travel to the waterfall east of Arandar.',
+        'Speak to the guardian of the water.',
+        'Navigate through the water cave.',
+        'Complete the waterfall gauntlet.',
+        'Retrieve the sacred totem.',
+        'Return to receive your reward.',
+    ],
+    url: 'https://oldschool.runescape.wiki/w/Waterfall_Quest',
+};
+export default WaterfallQuest;

package/dist/out-tsc/source/runescape/model/quest/all/WhatLiesBelow.js

@@ -0,0 +1,70 @@
+import { Skill } from "../../account/Skill";
+import { LevelRequirement } from "../../Requirement";
+import { QuestDifficulty, QuestLength } from "../enums";
+import { QuestStatus, RecommendationType } from "../Quest";
+/**
+ * Start point	Map icon Talk to Rat Burgiss south of Varrock. Show on map
+Official difficulty	Intermediate
+Official length	Short
+Description	A travelling trader has been stranded south of Varrock after his cart was attacked by local outlaws. He needs the help of a hero to recover his lost documents, but that's not all... The Varrock Palace Secret Guard (VPSG) are on the trail of treacherous dealings with the Monks of Zamorak. Will you be able to help the VPSG and uncover what lies below?
+Completion of the following quests:
+Rune Mysteries
+Runecraft 35 Runecraft  [not boostable] [required to start]
+Items required
+Empty bowl
+15 chaos runes
+Access to the Chaos Altar (Chaos talisman or tiara, Catalytic tiara, or travelling through the Abyss or Temple of the Eye)
+Recommended
+Combat level 30 Combat level
+Mining 42 Mining  [not boostable]
+Weapon, armour, and some food if low leveled
+Bronze pickaxe to avoid going into the Wilderness (a bronze pickaxe can be obtained during the quest)
+Fast travel to several locations around Varrock;
+Varrock square (Varrock teleport)
+Outlaw camp (Ring of Wealth to the Grand Exchange, Skills Necklace to the Cooks' Guild or Varrock teleport if medium Varrock Diary completed)
+South of Varrock (Chronicle, Combat bracelet to the Champions' Guild, or Senntisten teleport)
+The canoe system (requires axe and level 27 woodcutting for the Dugout canoe)
+[uncheck all]
+Enemies to defeat
+5 Outlaws (level 32)
+King Roald (level 47)
+ */
+const WhatLiesBelow = {
+    age: "",
+    description: "A travelling trader has been stranded south of Varrock after his cart was attacked by local outlaws. He needs the help of a hero to recover his lost documents, but that's not all... The Varrock Palace Secret Guard (VPSG) are on the trail of treacherous dealings with the Monks of Zamorak. Will you be able to help the VPSG and uncover what lies below?",
+    difficulty: QuestDifficulty.Intermediate,
+    id: 0,
+    length: QuestLength.Short,
+    members: true,
+    miniquest: false,
+    name: "What Lies Below",
+    questPoints: 2,
+    recommendations: [
+        { name: "30+ Combat level", type: RecommendationType.Tip },
+        { name: "Weapon, armour, and some food", type: RecommendationType.Tip },
+        { name: "Fast travel to several locations around Varrock", type: RecommendationType.Tip },
+        { name: "Bronze pickaxe to avoid going into the Wilderness", type: RecommendationType.Item },
+    ],
+    recommendedPrayers: [],
+    recommendedSkills: { Combat: 30, Mining: 42 },
+    requirements: [new LevelRequirement(Skill.Runecraft, 35, false)],
+    rewards: {
+        areas: [],
+        experience: [],
+        items: [],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 2,
+        unlocks: [],
+    },
+    series: null,
+    releaseDate: "27 March 2007",
+    shortName: "whatLiesBelow",
+    leadDeveloper: "Danny J",
+    startLocation: "South of Varrock",
+    status: QuestStatus.NotStarted,
+    steps: [],
+    url: "https://oldschool.runescape.wiki/w/What_Lies_Below",
+};
+export default WhatLiesBelow;

package/dist/out-tsc/source/runescape/model/quest/all/WitchesPotion.js

@@ -0,0 +1,43 @@
+import { QuestDifficulty, QuestLength } from '../enums';
+import { QuestStatus } from '../Quest';
+const WitchesPotion = {
+    age: 'First Age',
+    description: 'Help the witch by collecting ingredients for her potion in exchange for an artifact.',
+    difficulty: QuestDifficulty.Novice,
+    id: 0,
+    length: QuestLength.Short,
+    members: false,
+    miniquest: false,
+    name: "Witch's Potion",
+    questPoints: 1,
+    recommendations: [],
+    recommendedPrayers: [],
+    recommendedSkills: {},
+    requirements: [],
+    rewards: {
+        areas: [],
+        experience: [],
+        items: [{ name: 'Witchwood icon' }],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 1,
+        unlocks: [],
+    },
+    series: null,
+    shortName: 'witchesPotion',
+    startLocation: 'Witch house, south of Draynor Manor',
+    status: QuestStatus.NotStarted,
+    steps: [
+        'Talk to the Witch near Draynor Manor.',
+        'The witch asks you to collect ingredients for her potion.',
+        'Collect an eye of newt from Lumbridge Swamp.',
+        'Collect crushed eye of newt.',
+        'Collect ashes from a fireplace.',
+        'Collect a burnt meat from a fire.',
+        'Return to the witch with all ingredients.',
+        'Receive the witchwood icon.',
+    ],
+    url: 'https://oldschool.runescape.wiki/w/Witch%27s_Potion',
+};
+export default WitchesPotion;

package/dist/out-tsc/source/runescape/model/quest/all/WitchsHouse.js

@@ -0,0 +1,39 @@
+import { QuestDifficulty, QuestLength } from '../enums';
+import { QuestStatus } from '../Quest';
+/**
+ * Witch's House quest data
+ * @author James Cerniglia
+ * @see https://oldschool.runescape.wiki/w/Witch%27s_House for quest details and requirements
+ */
+const WitchsHouse = {
+    age: '',
+    description: '',
+    difficulty: QuestDifficulty.Intermediate,
+    id: 0,
+    length: QuestLength.Medium,
+    members: true,
+    miniquest: false,
+    name: "Witch's House",
+    questPoints: 4,
+    recommendations: [],
+    recommendedPrayers: [],
+    recommendedSkills: {},
+    requirements: [],
+    rewards: {
+        areas: [],
+        experience: [],
+        items: [],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 4,
+        unlocks: [],
+    },
+    series: null,
+    shortName: 'witchsHouse',
+    startLocation: '',
+    status: QuestStatus.NotStarted,
+    steps: [],
+    url: 'https://oldschool.runescape.wiki/w/Witch%27s_House',
+};
+export default WitchsHouse;

package/dist/out-tsc/source/runescape/model/quest/all/ZogreFleshEaters.js

@@ -0,0 +1,40 @@
+import { LevelRequirement } from "../../Requirement";
+import { QuestDifficulty, QuestLength } from "../enums";
+import { QuestStatus } from "../Quest";
+/**
+ * Zogre Flesh Eaters quest data
+ * @author James Cerniglia
+ * @see https://oldschool.runescape.wiki/w/Zogre_Flesh_Eaters for quest details and requirements
+ */
+const ZogreFleshEaters = {
+    age: "",
+    description: "",
+    difficulty: QuestDifficulty.Intermediate,
+    id: 0,
+    length: QuestLength.Medium,
+    members: true,
+    miniquest: false,
+    name: "Zogre Flesh Eaters",
+    questPoints: 1,
+    recommendations: [],
+    recommendedPrayers: [],
+    recommendedSkills: {},
+    requirements: [new LevelRequirement("Herblore", 8, false), new LevelRequirement("Smithing", 4, false), new LevelRequirement("Ranged", 30, false)],
+    rewards: {
+        areas: [],
+        experience: [],
+        items: [],
+        lamps: [],
+        pets: [],
+        points: [],
+        questPoints: 1,
+        unlocks: [],
+    },
+    series: "Ogre",
+    shortName: "zogreFleshEaters",
+    startLocation: "",
+    status: QuestStatus.NotStarted,
+    steps: [],
+    url: "https://oldschool.runescape.wiki/w/Zogre_Flesh_Eaters",
+};
+export default ZogreFleshEaters;

package/dist/out-tsc/source/runescape/model/quest/enums.js

@@ -0,0 +1,34 @@
+/**
+ * Quest difficulty levels in OSRS
+ */
+export var QuestDifficulty;
+(function (QuestDifficulty) {
+    QuestDifficulty["Novice"] = "Novice";
+    QuestDifficulty["Intermediate"] = "Intermediate";
+    QuestDifficulty["Experienced"] = "Experienced";
+    QuestDifficulty["Master"] = "Master";
+    QuestDifficulty["Grandmaster"] = "Grandmaster";
+})(QuestDifficulty || (QuestDifficulty = {}));
+/**
+ * Quest length categories in OSRS
+ */
+export var QuestLength;
+(function (QuestLength) {
+    QuestLength["VeryShort"] = "Very short";
+    QuestLength["Short"] = "Short";
+    QuestLength["ShortMedium"] = "Short-Medium";
+    QuestLength["Medium"] = "Medium";
+    QuestLength["MediumLong"] = "Medium-Long";
+    QuestLength["Long"] = "Long";
+    QuestLength["VeryLong"] = "Very long";
+})(QuestLength || (QuestLength = {}));
+/**
+ * Current status of a quest for a player
+ */
+export var QuestStatus;
+(function (QuestStatus) {
+    QuestStatus["NotStarted"] = "NotStarted";
+    QuestStatus["InProgress"] = "InProgress";
+    QuestStatus["Completed"] = "Completed";
+    QuestStatus["Failed"] = "Failed";
+})(QuestStatus || (QuestStatus = {}));

package/dist/out-tsc/source/runescape/model/quest/types.js

@@ -0,0 +1,5 @@
+/**
+ * Re-export all quest-related types for public API
+ */
+export { RecommendationType } from './Quest';
+export { QuestDifficulty, QuestLength, QuestStatus } from './enums';

package/dist/out-tsc/source/runescape/model/slayer/Assignment.js

@@ -0,0 +1,29 @@
+// A Class that represents an assignment of a task to a player.
+// An assignment is a specific instance of a task, with a specific quantity and requirements.
+// The assignment is the actual task given to a player, which is based on the Task.
+export class Assignment {
+    name;
+    quantity;
+    requirements;
+    extendedAmountMin;
+    extendedAmountMax;
+    constructor(name, quantity, requirements, extendedAmountMin, extendedAmountMax) {
+        this.name = name;
+        this.quantity = quantity;
+        this.requirements = requirements;
+        this.extendedAmountMin = extendedAmountMin ?? null;
+        this.extendedAmountMax = extendedAmountMax ?? null;
+    }
+    /**
+     * Get the task name
+     */
+    getName() {
+        return this.name;
+    }
+    /**
+     * Get the quantity of the task
+     */
+    getQuantity() {
+        return this.quantity;
+    }
+}

package/dist/out-tsc/source/runescape/model/slayer/Masters.js

@@ -0,0 +1,101 @@
+import { SlayerMaster } from './SlayerMaster';
+import { chaeldarTasks } from './task/ChaelderTasks';
+import { duradelTasks } from './task/DuradelTasks';
+import { konarTasks } from './task/KonarTasks';
+import { krystiliaTasks } from './task/KrystiliaTasks';
+import { mazchnaTasks } from './task/MazchnaTasks';
+import { nieveTasks } from './task/NieveTasks';
+import { spriaTasks } from './task/SpriaTasks';
+import { turealTasks } from './task/TurealTasks';
+import { vannakaTasks } from './task/VannakaTasks';
+// TODO: Add the rest of the tasks for each master
+// TODO: Add the rest of the masters
+// TODO: Ensure points are correct
+// Mazchna: https://oldschool.runescape.wiki/w/Mazchna
+export const Mazchna = new SlayerMaster('Mazchna', mazchnaTasks, 'Canifis', 0, 'https://oldschool.runescape.wiki/w/Mazchna', {
+    1: 2,
+    10: 5,
+    100: 50,
+    1000: 100,
+    250: 70,
+    50: 15,
+}, undefined);
+// Spria: https://oldschool.runescape.wiki/w/Spria
+export const Spria = new SlayerMaster('Spria', spriaTasks, 'Draynor Village', 0, 'https://oldschool.runescape.wiki/w/Spria', {
+    1: 2,
+    10: 5,
+    100: 50,
+    1000: 100,
+    250: 70,
+    50: 15,
+}, undefined);
+// Tureal: https://oldschool.runescape.wiki/w/Turael
+export const Turael = new SlayerMaster('Turael', turealTasks, 'Burthope', 0, 'https://oldschool.runescape.wiki/w/Turael', {
+    1: 2,
+    10: 5,
+    100: 50,
+    1000: 100,
+    250: 70,
+    50: 15,
+}, undefined);
+// Vannaka: https://oldschool.runescape.wiki/w/Vannaka
+export const Vannaka = new SlayerMaster('Vannaka', vannakaTasks, 'Edgeville Dungeon', 0, 'https://oldschool.runescape.wiki/w/Vannaka', {
+    1: 2,
+    10: 5,
+    100: 50,
+    1000: 100,
+    250: 70,
+    50: 15,
+}, undefined);
+// Konar Quo Maten: https://oldschool.runescape.wiki/w/Konar_Quo_Maten
+export const KonarQuoMaten = new SlayerMaster('Konar Quo Maten', konarTasks, 'Mount Karuulm', 0, 'https://oldschool.runescape.wiki/w/Konar_Quo_Maten', {
+    1: 2,
+    10: 5,
+    100: 50,
+    1000: 100,
+    250: 70,
+    50: 15,
+}, undefined);
+// Krystilia: https://oldschool.runescape.wiki/w/Krystilia
+export const Krystilia = new SlayerMaster('Krystilia', krystiliaTasks, 'Edgeville', 0, 'https://oldschool.runescape.wiki/w/Krystilia', {
+    1: 2,
+    10: 5,
+    100: 50,
+    1000: 100,
+    250: 70,
+    50: 15,
+}, undefined);
+// Nieve: https://oldschool.runescape.wiki/w/Nieve
+export const Nieve = new SlayerMaster('Nieve', nieveTasks, "Nieve's Cave", 0, 'https://oldschool.runescape.wiki/w/Nieve', {
+    1: 12,
+    10: 60,
+    100: 300,
+    1000: 600,
+    250: 420,
+    50: 180,
+}, {
+    1: 15,
+    10: 75,
+    100: 375,
+    1000: 750,
+    250: 525,
+    50: 225,
+});
+// Duradel: https://oldschool.runescape.wiki/w/Duradel
+export const Duradel = new SlayerMaster('Duradel', duradelTasks, 'Shilo Village', 85, 'https://oldschool.runescape.wiki/w/Duradel', {
+    1: 15,
+    10: 75,
+    100: 375,
+    1000: 750,
+    250: 525,
+    50: 225,
+}, undefined);
+// Chaeldar: https://oldschool.runescape.wiki/w/Chaeldar
+export const Chaeldar = new SlayerMaster('Chaeldar', chaeldarTasks, 'Zanaris', 0, 'https://oldschool.runescape.wiki/w/Chaeldar', {
+    1: 10,
+    10: 50,
+    100: 250,
+    1000: 500,
+    250: 350,
+    50: 150,
+}, undefined);

package/dist/out-tsc/source/runescape/model/slayer/SlayerBuys.js

@@ -0,0 +1,30 @@
+import { SlayerBuy } from './SlayerReward';
+const SlayerBuys = [
+    {
+        item: 'Slayer ring',
+        notes: 'An equippable ring that provides all the functions of an Enchanted gem, and provides 8 charges for teleporting to useful Slayer sites.',
+        priceSoldAt: 75,
+    },
+    {
+        item: 'Broad bolts (x250)',
+        notes: 'Bolts that can damage Turoths and Kurask. Level 55 Slayer and 61 Ranged, alongside a suitable bow, are required to fire these bolts.',
+        priceSoldAt: 35,
+    },
+    {
+        item: 'Broad arrows (x250)',
+        notes: 'Arrows that can damage Turoths and Kurask. Level 55 Slayer and 50 Ranged, alongside a suitable bow, are required to fire these arrows.',
+        priceSoldAt: 35,
+    },
+    {
+        item: 'Herb sack',
+        notes: 'Stores up to 30 of each type of grimy herb (for a total of 420 herbs). Level 58 Herblore is required to use it.',
+        priceSoldAt: 750,
+    },
+    {
+        item: 'Rune pouch',
+        notes: 'Stores up to 16,000 of three types of runes. Only one can be owned. Can also be obtained by exchanging a rune pouch note at a bank.',
+        priceSoldAt: 750,
+    },
+];
+export { SlayerBuy, SlayerBuys };
+module.exports = exports = { SlayerBuys };