osrs-tools 2.10.0 → 2.11.1

package/README.md

@@ -1,88 +1,25 @@
 # OSRS Tools
 
-[![NPM Version](https://img.shields.io/npm/v/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
-[![Downloads](https://img.shields.io/npm/dm/osrs-tools.svg?style=for-the-badge)](https://www.npmjs.com/package/osrs-tools)
-[![CI](https://img.shields.io/github/actions/workflow/status/jamescer/osrs-tools/ci.yml?branch=master&style=for-the-badge&label=CI)](https://github.com/jamescer/osrs-tools/actions/workflows/ci.yml)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg?style=for-the-badge)](https://www.typescriptlang.org)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
-[![Node Version](https://img.shields.io/node/v/osrs-tools.svg?style=for-the-badge)](https://nodejs.org)
-[![Test Coverage](https://img.shields.io/codecov/c/github/jamescer/osrs-tools.svg?style=for-the-badge)](https://codecov.io/gh/jamescer/osrs-tools)
+[![NPM Version](https://img.shields.io/npm/v/osrs-tools.svg?style=flat-square)](https://www.npmjs.com/package/osrs-tools)
+[![Downloads](https://img.shields.io/npm/dm/osrs-tools.svg?style=flat-square)](https://www.npmjs.com/package/osrs-tools)
+[![CI](https://img.shields.io/github/actions/workflow/status/jamescer/osrs-tools/ci.yml?branch=master&style=flat-square&label=CI)](https://github.com/jamescer/osrs-tools/actions/workflows/ci.yml)
+[![Test Coverage](https://img.shields.io/codecov/c/github/jamescer/osrs-tools.svg?style=flat-square)](https://codecov.io/gh/jamescer/osrs-tools)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](./license)
 
-> A comprehensive TypeScript library for Old School RuneScape (OSRS) data, tools, and game modeling.
+A fully-typed TypeScript library of Old School RuneScape game data and logic — quests, accounts, diaries, combat achievements, slayer, clues, items, and more.
 
-**Type-safe**   **Zero runtime dependencies**   **CJS + ESM**   **Tree-shakeable**   **Well-tested**
+Zero runtime dependencies, dual CJS/ESM output, tree-shakeable, Node ≥ 18.
 
-## Table of Contents
-
-- [Overview](#overview)
-- [Installation](#installation)
-- [Features](#features)
-- [Usage](#usage)
-- [API Reference](#api-reference)
-- [Development](#development)
-- [Contributing](#contributing)
-- [Support](#support)
-- [License](#license)
-
-## Overview
-
-`osrs-tools` gives OSRS developers a fully-typed model of the game, covering:
-
-- full quest and requirement system with 189+ quests and miniquests
-- account data modeling for skills, bosses, clues, and progression
-- achievement diary lookups for all 10 regions, with a `DiaryTool` for account-based progress checks
-- Combat Achievements: all 637 tasks across six tiers, with a `CombatAchievementTool` for points and reward-tier progress
-- clue scroll reward simulation with wiki-accurate odds
-- item data model with combat stats and clue/quest item registries
-- slayer masters, tasks, reward unlocks/extends/buys, and point tables
-- hunter guild, rumours, and master progression
-- skill metadata, experience tables, and combat helpers
-- league support (Demonic Pacts, Raging Echoes)
-- custom `ValidationError` for consistent error handling
-
-This library is built for analytics, web apps, and toolchains that need OSRS game logic and data. It ships as dual CommonJS/ESM with bundled type definitions, has a single runtime dependency (`tslib`), and is marked side-effect free for tree-shaking.
-
-## Installation
-
-### Prerequisites
-
-- Node.js 18.x or higher
-
-TypeScript is not required to consume this package — it ships compiled JavaScript with bundled `.d.ts` type definitions — but is recommended to get full type-checking in your own project.
-
-### Install
+## Install
 
 ```bash
 npm install osrs-tools
 ```
 
-## Features
-
-- Quest system with all OSRS quests and recursive requirement checking
-- `OsrsAccount` skill, score, and combat level lookups
-- Achievement diaries with full task and requirement breakdowns via `DiaryTool`
-- Combat Achievements: all 637 tasks, reward-tier unlocks, and points calculation via `CombatAchievementTool`
-- Clue scroll casket simulation with tier-specific tables and mimic handling
-- Item model with combat stats, alch values, and quest/clue item flags
-- Slayer masters (Turael through Krystilia), task weights, point tables, reward utilities
-- Hunter guild rumours, masters, and locations
-- League modules for Demonic Pacts and Raging Echoes
-- Skill metadata helpers (24 skills including Sailing) and experience tables
-- Requirement classes covering levels, quests, items, combat, location, and more
-- `ValidationError` for uniform error handling across the library
-
-## Usage
-
-### Core Import
+## Quick Start
 
 ```typescript
-import {
-  QuestTool,
-  OsrsAccount,
-  ClueScrollHelper,
-  Item,
-  ValidationError,
-} from "osrs-tools";
+import { QuestTool, OsrsAccount } from "osrs-tools";
 
 const account = OsrsAccount.fromJson({
   name: "Player123",
@@ -95,191 +32,35 @@ const account = OsrsAccount.fromJson({
 
 const questTool = new QuestTool(account);
 const dragonSlayer = QuestTool.getQuestByName("Dragon Slayer I");
-const canComplete = questTool.canCompleteQuest(dragonSlayer);
 
-console.log("Requirements:", dragonSlayer?.requirements);
-console.log("Can complete?", canComplete);
+console.log(questTool.canCompleteQuest(dragonSlayer));
 ```
 
-### Subpath Imports
+Import from the root package or from a subpath to keep bundles small:
 
 ```typescript
-import { QuestTool, DragonSlayerI } from "osrs-tools/quest";
 import { Duradel, getMasterByName } from "osrs-tools/slayer";
-import { OsrsAccount, Skill } from "osrs-tools/account";
-import diaries, { getDiaryByName, getAllDiaries, DiaryTool } from "osrs-tools/diary";
-import { CombatAchievementTool, ALL_COMBAT_ACHIEVEMENT_TASKS } from "osrs-tools/combat-achievements";
-import { getExperienceForLevel, getLevelForExperience } from "osrs-tools/tools";
-import { validateSkillLevel, getSkillsByCategory } from "osrs-tools/utils";
-```
-
-## API Reference
-
-### Quest System (`osrs-tools/quest`)
-
-- `QuestTool` — account-based quest completion checks and quest registry
-- `QuestTool.getQuestByName(name)` — look up a quest by name
-- `QuestList`, `MiniQuestList` — full quest and miniquest registries
-- `QuestDifficulty`, `QuestLength`, `QuestStatus` — enums for quest metadata
-- 189+ individual quest classes (e.g., `DragonSlayerI`, `AKingdomDivided`)
-- Requirement classes:
-  - `LevelRequirement` — skill level with optional boost support
-  - `SlayerLevelRequirement` — slayer-specific level checks
-  - `CombatLevelRequirement` — combat level gate
-  - `QuestRequirement` — quest completion dependency
-  - `ItemRequirement` — item with quantity, consumption, alternatives, and bankable flags
-  - `LocationRequirement` — geographic access requirement
-  - `QuestPointRequirement` — quest point gate
-  - `SlayerUnlockRequirement` — slayer unlock dependency
-
-### Account Modeling (`osrs-tools/account`)
-
-- `OsrsAccount.fromJson(json)` — parse an account from hiscores-style JSON
-- Skill access via `Skill` enum (24 skills: Attack, Defence, Strength, Hitpoints, Ranged, Prayer, Magic, Woodcutting, Fishing, Firemaking, Crafting, Smithing, Mining, Herblore, Agility, Thieving, Slayer, Farming, Runecraft, Hunter, Construction, Cooking, Fletching, Sailing)
-- `SKILL_METADATA` — per-skill metadata including category, maxLevel, and isBoostable
-
-### Achievement Diaries (`osrs-tools/diary`)
-
-- `diaries` default export — all diaries
-- `getDiaryByName(name)` — look up a diary by region name
-- `getAllDiaries()` — array of all 10 regional diaries
-- Regions: Ardougne, Desert, Fremennik, Kandarin, Karamja, Kourend & Kebos, Lumbridge & Draynor, Morytania, Varrock, Wilderness
-- Each diary includes Easy/Medium/Hard/Elite tasks with full requirement breakdowns
-- `DiaryTool` — account-bound task checks:
-  - `canCompleteTask(task)` / `canCompleteLevel(level)` — checks Level/Quest/CombatLevel/QuestPoint requirements
-  - `getCompletableTasks(source)` / `getRemainingTasks(source)` — accepts a full `Diary` or a single `DiaryLevel`
-  - `getDiaryProgress(diary)` — completable/remaining/total breakdown per tier
-
-### Combat Achievements (`osrs-tools/combat-achievements`)
-
-- All 637 tasks across six tiers (Easy 41 / Medium 60 / Hard 85 / Elite 162 / Master 168 / Grandmaster 121), sourced from the OSRS Wiki
-- `ALL_COMBAT_ACHIEVEMENT_TASKS`, `EASY_COMBAT_ACHIEVEMENTS` ... `GRANDMASTER_COMBAT_ACHIEVEMENTS` — task lists per tier
-- `getCombatAchievementByName(name)`, `getCombatAchievementsByTier(tier)`, `getCombatAchievementsByMonster(monster)`
-- `COMBAT_ACHIEVEMENT_REWARD_TIERS` — the 6 cumulative point thresholds (41/161/416/1064/1904/2630) and their reward text
-- `CombatAchievementTool`:
-  - `hasEngagedMonster(task)` — best-effort accessibility signal from the account's boss kill count; task completion itself isn't exposed via hiscores and can't be verified
-  - `getAccessibleTasks(tasks)` / `getInaccessibleTasks(tasks)`
-  - `calculatePoints(completedTaskNames)` — points for a caller-supplied list of completed task names
-  - `getUnlockedRewardTiers(points)` / `getNextRewardTier(points)`
-  - `getProgress(completedTaskNames)` — full per-tier breakdown plus unlocked/next reward tiers
-
-```typescript
+import { DiaryTool, getDiaryByName } from "osrs-tools/diary";
 import { CombatAchievementTool } from "osrs-tools/combat-achievements";
-
-const caTool = new CombatAchievementTool(account);
-const progress = caTool.getProgress(["Barrows Novice", "Noxious Foe"]);
-console.log(progress.totalPoints, progress.nextRewardTier?.tier);
 ```
 
-### Clue Scroll Simulation
-
-Available from the main `osrs-tools` import:
-
-```typescript
-import { ClueScrollHelper } from "osrs-tools";
-
-const result = ClueScrollHelper.openCasket("hard");
-console.log(result.items, result.mimicTriggered);
-```
-
-- `ClueScrollHelper.openCasket(tier)` — simulate a casket opening with wiki-accurate odds
-- Tiers: `beginner`, `easy`, `medium`, `hard`, `elite`, `master`
-- `CasketReward` interface: `{ items, count, masterClue, mimicTriggered, mimicGuaranteed, mimicBonusItem }`
-
-### Items
-
-Available from the main `osrs-tools` import:
-
-- `Item` — item data model with combat stats (attack/defence stab/slash/crush/magic/ranged, melee/ranged/magic bonuses, prayer), alch values, weight, tradeable/equipable/stackable flags
-- `ClueRewards` — item registries for clue scroll reward tables
-- `QuestItems` — item registry for quest-related items
+## What's included
 
-### Slayer System (`osrs-tools/slayer`)
+| Module | Subpath | Highlights |
+| --- | --- | --- |
+| Quests | `osrs-tools/quest` | `QuestTool`, 189+ quests, requirement classes (level, quest, item, combat, location…) |
+| Accounts | `osrs-tools/account` | `OsrsAccount` (hiscores-compatible), `Skill` enum, skill metadata |
+| Diaries | `osrs-tools/diary` | 10 regional achievement diaries, `DiaryTool` for progress checks |
+| Combat Achievements | `osrs-tools/combat-achievements` | All 637 tasks across six tiers, `CombatAchievementTool` |
+| Slayer | `osrs-tools/slayer` | 9 masters, tasks, points, unlocks/extends/buys |
+| Experience | `osrs-tools/tools` | XP ⇄ level conversion, full XP table |
+| Validation | `osrs-tools/utils` | Skill/level validation, `ValidationError` |
+| Clues, items, guilds, leagues | root `osrs-tools` import | `ClueScrollHelper`, `Item`, `HunterGuild`, league data |
 
-#### Masters
-
-| Class | `getMasterByName` key |
-| --- | --- |
-| `Turael` | `"Turael"` |
-| `Spria` | `"Spria"` |
-| `Mazchna` | `"Mazchna"` |
-| `Vannaka` | `"Vannaka"` |
-| `Chaeldar` | `"Chaeldar"` |
-| `KonarQuoMaten` | `"Konar quo Maten"` |
-| `Nieve` | `"Nieve"` |
-| `Duradel` | `"Duradel"` |
-| `Krystilia` | `"Krystilia"` |
-
-#### Registry Utilities
-
-- `getMasterByName(name)` — look up a master by name
-- `getAllMasters()` — all slayer masters
-- `getMastersByMinimumLevel(level)` — masters accessible at a given combat level
-- `getMastersByProgression()` — masters ordered by progression
-- `getRandomMasterForLevel(level)` — random master appropriate for a level
-
-#### Rewards
-
-- `SlayerUnlock`, `SlayerExtend`, `SlayerBuy` — reward classes
-- `SLAYER_UNLOCKS`, `SLAYER_EXTENDS`, `SLAYER_BUYS` — full data sets
-- `getUnlockByName`, `getUnlocksByCostRange`, `calculateUnlocksCost`
-- `getExtendByName`, `getExtendsForTask`
-- `getBuyByItem`, `getBuysByCostRange`, `getBuysByRequirement`, `calculateBuysCost`
-
-#### Data & Constants
-
-- `POINTS_TABLE` — point rewards per master and streak
-- `SLAYER_EXP_RATES`, `STANDARD_TASK_WEIGHTS`, `TASK_QUANTITY_PRESETS`, `EXTENDED_QUANTITY_PRESETS`
-- `SlayerLocation`, `SlayerBoss`, `MonsterType` enums
-
-### Experience Tools (`osrs-tools/tools`)
-
-- `getExperienceForLevel(level: number): number` — XP required to reach a level
-- `getLevelForExperience(xp: number): number` — level at a given XP total
-- `LEVEL_TO_EXPERIENCE: Record<number, number>` — full XP table (levels 1–99)
-
-### Guilds
-
-Available from the main `osrs-tools` import:
-
-#### Hunter Guild
-
-- `HunterGuild` — guild class
-- `HunterGuildMaster` — master NPC with progression data
-- `HunterGuildMasterName` — enum of master names
-- `HunterRumour` — rumour entry with location and loot
-- `Rumours` — full rumour registry
-- `RumourLocation` — location data for rumours
-
-### Leagues
-
-Available from the main `osrs-tools` import:
-
-- `League` interface — relics, reward tiers, and relic tiers
-- `Relic` — selectable relic with passive bonuses
-- `RelicTier` — tier with XP/drop multipliers
-- `RewardTier` — milestone reward unlock
-- `DemonicPactsLeagueAreas` — area data for Demonic Pacts
-- `RagingEchoesLeague` — region and relic data for Raging Echoes
-- `LeagueRegion`, `NotableDrop`, `GenericLeagueRegion` enums
-
-### Validation & Skill Utilities (`osrs-tools/utils`)
-
-- `validateSkillLevel(level: number, skillName: string): void` — throws `ValidationError` for invalid levels
-- `validateQuestPoints(points: number): void` — throws `ValidationError` for invalid point totals
-- `getSkillMetadata(skill: Skill | string): SkillMetadata | undefined`
-- `isValidSkill(skillName: string): boolean`
-- `isValidLevel(skill: Skill | string, level: number): boolean`
-- `getSkillsByCategory(category: "combat" | "gathering" | "production" | "support"): Skill[]`
-
-### Error Handling
-
-- `ValidationError` — extends `Error` with `fieldName: string`, `value: unknown`, and optional `context: Record<string, unknown>`
+For the full API surface and source layout, see [summary.md](./summary.md).
 
 ## Development
 
-### Local Setup
-
 ```bash
 git clone https://github.com/jamescer/osrs-tools.git
 cd osrs-tools
@@ -288,110 +69,30 @@ npm run build
 npm test
 ```
 
-### Available Scripts
-
-| Command                 | Description                           |
-| ----------------------- | ------------------------------------- |
-| `build`                 | Compile TypeScript to `dist/`         |
-| `build:npm`             | Build with publish tsconfig           |
-| `clean`                 | Remove `dist/` output directory       |
-| `dev`                   | Watch mode compilation                |
-| `test`                  | Run test suite                        |
-| `test:watch`            | Run tests in watch mode               |
-| `test:coverage`         | Generate coverage report              |
-| `coverage`              | Run coverage and upload to Codecov    |
-| `format`                | Format source and tests with Prettier |
-| `lint`                  | Lint and auto-fix with ESLint         |
-| `publish-test`          | Dry-run `npm publish`                 |
-
-### Project Structure
-
-```text
-src/
-├── index.ts                          # Main entry point
-└── runescape/
-    ├── errors.ts                     # ValidationError
-    ├── model/
-    │   ├── Requirement.ts            # All requirement classes and RequirementType enum
-    │   ├── account/                  # OsrsAccount, Skill enum, SKILL_METADATA
-    │   │   └── skills/unlocks/       # AttackUnlocks, SkillUnlock
-    │   ├── clue/                     # ClueScrollHelper, ClueScrollRewards
-    │   ├── diaries/                  # 10 regional diary modules + DiaryTool
-    │   ├── combat-achievements/      # 637 tasks (6 tiers), reward tiers, CombatAchievementTool
-    │   ├── guilds/
-    │   │   └── hunter/               # HunterGuild, HunterGuildMaster, Rumours, RumourLocation
-    │   ├── items/                    # Item, ClueRewards, QuestItems
-    │   ├── leagues/                  # DemonicPactsLeague, RagingEchoesLeague, League interfaces
-    │   ├── quest/
-    │   │   ├── QuestTool.ts
-    │   │   ├── QuestList.ts
-    │   │   ├── MiniQuestList.ts
-    │   │   └── all/                  # 189+ individual quest classes
-    │   ├── skills/                   # Skill interface, attack and hunter skill modules
-    │   └── slayer/
-    │       ├── core/                 # SlayerMaster, Task, Assignment
-    │       ├── masters/              # 9 master classes + registry
-    │       ├── rewards/              # SlayerUnlock, SlayerExtend, SlayerBuy + data
-    │       └── tasks/                # Task constants and weights
-    ├── tools/
-    │   └── experience.ts             # getExperienceForLevel, getLevelForExperience, LEVEL_TO_EXPERIENCE
-    └── utils/
-        ├── validation.ts             # validateSkillLevel, validateQuestPoints
-        └── skillUtils.ts             # getSkillMetadata, isValidSkill, getSkillsByCategory, isValidLevel
+| Command | Description |
+| --- | --- |
+| `npm run build` | Compile TypeScript to `dist/` |
+| `npm test` | Run the test suite |
+| `npm run lint` | Lint and auto-fix with ESLint |
+| `npm run format` | Format with Prettier |
+| `npm run changeset` | Record a change for the next release |
 
-test/
-└── unit/
-    ├── account/
-    ├── diaries/
-    ├── combat-achievements/
-    ├── quest/
-    ├── slayer/
-    ├── model/
-    ├── tools/
-    └── utils/
-
-dist/                                 # Compiled output (generated by build)
-```
+See [dev_setup.md](./dev_setup.md) for the full setup and release workflow.
 
 ## Contributing
 
-We welcome contributions! We use [Conventional Commits](https://www.conventionalcommits.org/).
-
-### Getting Started
-
-1. Fork and clone the repository
-2. Create a branch (`feat/amazing-feature`)
-3. Make your changes and add tests
-4. Run `npm test && npm run lint`
-5. Commit with conventional format:
-
-   ```text
-   feat: add quest requirement validation
-   fix: correct slayer task weights
-   docs: update API documentation
-   ```
+Contributions are welcome. We use [Conventional Commits](https://www.conventionalcommits.org/) and [changesets](https://github.com/changesets/changesets) for releases.
 
-6. Push and open a Pull Request
+1. Fork and clone the repo, create a branch
+2. Make your change and add tests
+3. `npm test && npm run lint`
+4. `npm run changeset` to record a changelog entry
+5. Open a pull request
 
-### Guidelines
-
-- Add tests for new features
-- Update documentation for public API changes
-- Follow existing code style
-- Keep changes focused
-
-## Support
-
-- [Report Issues](https://github.com/jamescer/osrs-tools/issues)
-- [Request Features](https://github.com/jamescer/osrs-tools/issues)
-- [Discussions](https://github.com/jamescer/osrs-tools/discussions)
+Please also review our [Code of Conduct](./code-of-conduct.md) and [Security Policy](./SECURITY.md).
 
 ## License
 
-[MIT](./LICENSE) © James Cerniglia
-
-## Credits
+[MIT](./license) © [James Cerniglia](mailto:jamesmcerniglia@gmail.com)
 
-- **Author**: [James Cerniglia](mailto:jamesmcerniglia@gmail.com)
-- **Contributors**: [View all contributors](https://github.com/jamescer/osrs-tools/graphs/contributors)
-- **Data Source**: [Old School RuneScape Wiki](https://oldschool.runescape.wiki/)
+Data sourced from the [Old School RuneScape Wiki](https://oldschool.runescape.wiki/).

package/dist/index.d.ts

@@ -27,7 +27,7 @@ export * from './runescape/model/diaries';
 export * from './runescape/model/quest/QuestTool';
 export * from './runescape/model/items';
 export * from './runescape/model/leagues';
-export { Assignment, Chaeldar, Duradel, getAllMasters, getMasterByName, getMastersByMinimumLevel, getMastersByProgression, KonarQuoMaten, Krystilia, Mazchna, Nieve, POINTS_TABLE, SLAYER_BUYS, SLAYER_EXTENDS, SLAYER_UNLOCKS, SlayerBoss, SlayerBuy, SlayerExtend, SlayerLocation, SlayerMaster, SlayerUnlock, Spria, Task, Turael, Vannaka, } from './runescape/model/slayer';
+export { Assignment, Chaeldar, Duradel, getAllMasters, getMasterByName, getMastersByMinimumLevel, getMastersByProgression, KonarQuoMaten, Krystilia, Mazchna, Mortifier, MORTIFIERS, Mortimer, MortimerSlayerMaster, Nieve, POINTS_TABLE, SLAYER_BUYS, SLAYER_EXTENDS, SLAYER_UNLOCKS, SlayerBoss, SlayerBuy, SlayerExtend, SlayerLocation, SlayerMaster, SlayerUnlock, Spria, Task, Turael, Vannaka, } from './runescape/model/slayer';
 export * from './runescape/model/guilds';
 export * from './runescape/model/skills';
 export * from './runescape/errors';

package/dist/index.js

@@ -31,7 +31,7 @@ export * from './runescape/model/items';
 // Leagues
 export * from './runescape/model/leagues';
 // Slayer system
-export { Assignment, Chaeldar, Duradel, getAllMasters, getMasterByName, getMastersByMinimumLevel, getMastersByProgression, KonarQuoMaten, Krystilia, Mazchna, Nieve, POINTS_TABLE, SLAYER_BUYS, SLAYER_EXTENDS, SLAYER_UNLOCKS, SlayerBoss, SlayerBuy, SlayerExtend, SlayerLocation, SlayerMaster, SlayerUnlock, Spria, Task, Turael, Vannaka, } from './runescape/model/slayer';
+export { Assignment, Chaeldar, Duradel, getAllMasters, getMasterByName, getMastersByMinimumLevel, getMastersByProgression, KonarQuoMaten, Krystilia, Mazchna, Mortifier, MORTIFIERS, Mortimer, MortimerSlayerMaster, Nieve, POINTS_TABLE, SLAYER_BUYS, SLAYER_EXTENDS, SLAYER_UNLOCKS, SlayerBoss, SlayerBuy, SlayerExtend, SlayerLocation, SlayerMaster, SlayerUnlock, Spria, Task, Turael, Vannaka, } from './runescape/model/slayer';
 // Guilds system
 export * from './runescape/model/guilds';
 // Skills system

package/dist/runescape/model/slayer/core/Mortifier.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Mortifiers - Mortimer's unique task modifier system
+ * Reference: https://oldschool.runescape.wiki/w/Mortimer
+ *
+ * Unlike other Slayer Masters, Mortimer does not reward Slayer points as the primary
+ * incentive for completing tasks. Instead his tasks carry a "Mortifier" - a modifier
+ * that is unlocked permanently as a player completes more tasks with him, and which
+ * is then applied (with a variable magnitude, "X") to a given task offer.
+ *
+ * NOTE: Mortimer and Wyrmscraig were, at time of writing, planned but not yet
+ * released content (Player Designed Island Competition). Names, thresholds and
+ * effects may change before/if this is implemented in the live game.
+ */
+export interface MortifierConfig {
+    id: number;
+    name: string;
+    /** Number of Slayer tasks completed with Mortimer required to unlock this Mortifier. */
+    unlockThreshold: number;
+    description: string;
+}
+export declare class Mortifier {
+    id: number;
+    name: string;
+    unlockThreshold: number;
+    description: string;
+    constructor(config: MortifierConfig);
+    /**
+     * Get the number of tasks that must be completed with Mortimer to unlock this Mortifier.
+     */
+    getUnlockThreshold(): number;
+    /**
+     * Whether this Mortifier is unlocked for a player with the given number of completed tasks.
+     */
+    isUnlockedAt(completedTasks: number): boolean;
+    getDescription(): string;
+}
+/**
+ * All Mortifiers, in unlock order.
+ */
+export declare const MORTIFIERS: Mortifier[];
+/**
+ * Get every Mortifier unlocked for a player with the given number of tasks completed with Mortimer.
+ */
+export declare function getAvailableMortifiers(completedTasks: number): Mortifier[];
+/**
+ * Get a single Mortifier by its name (case insensitive).
+ */
+export declare function getMortifierByName(name: string): Mortifier | undefined;

package/dist/runescape/model/slayer/core/Mortifier.js

@@ -0,0 +1,100 @@
+/**
+ * Mortifiers - Mortimer's unique task modifier system
+ * Reference: https://oldschool.runescape.wiki/w/Mortimer
+ *
+ * Unlike other Slayer Masters, Mortimer does not reward Slayer points as the primary
+ * incentive for completing tasks. Instead his tasks carry a "Mortifier" - a modifier
+ * that is unlocked permanently as a player completes more tasks with him, and which
+ * is then applied (with a variable magnitude, "X") to a given task offer.
+ *
+ * NOTE: Mortimer and Wyrmscraig were, at time of writing, planned but not yet
+ * released content (Player Designed Island Competition). Names, thresholds and
+ * effects may change before/if this is implemented in the live game.
+ */
+export class Mortifier {
+    id;
+    name;
+    unlockThreshold;
+    description;
+    constructor(config) {
+        this.id = config.id;
+        this.name = config.name;
+        this.unlockThreshold = config.unlockThreshold;
+        this.description = config.description;
+    }
+    /**
+     * Get the number of tasks that must be completed with Mortimer to unlock this Mortifier.
+     */
+    getUnlockThreshold() {
+        return this.unlockThreshold;
+    }
+    /**
+     * Whether this Mortifier is unlocked for a player with the given number of completed tasks.
+     */
+    isUnlockedAt(completedTasks) {
+        return completedTasks >= this.unlockThreshold;
+    }
+    getDescription() {
+        return this.description;
+    }
+}
+const BonusSlayerPoints = new Mortifier({
+    description: 'Task awards X additional Slayer Points on completion.',
+    id: 1,
+    name: 'Bonus Slayer Points',
+    unlockThreshold: 0,
+});
+const QuantityModifier = new Mortifier({
+    description: 'Task quantity modified by X%.',
+    id: 2,
+    name: 'Quantity Modifier',
+    unlockThreshold: 0,
+});
+const ClueScrollBoost = new Mortifier({
+    description: 'Clue scroll drop-rates are increased by X%.',
+    id: 3,
+    name: 'Clue Scroll Boost',
+    unlockThreshold: 15,
+});
+const SuperiorUniqueBoost = new Mortifier({
+    description: "Slayer creatures' superiors access the superior unique table X% more often.",
+    id: 4,
+    name: 'Superior Unique Boost',
+    unlockThreshold: 25,
+});
+const BonusSlayerExp = new Mortifier({
+    description: 'Slayer creatures award X% more Slayer XP.',
+    id: 5,
+    name: 'Bonus Slayer Exp',
+    unlockThreshold: 40,
+});
+const ThirdTaskChoice = new Mortifier({
+    description: 'Adds a third task choice to Mortimer task offers.',
+    id: 6,
+    name: 'Third Task Choice',
+    unlockThreshold: 50,
+});
+/**
+ * All Mortifiers, in unlock order.
+ */
+export const MORTIFIERS = [
+    BonusSlayerPoints,
+    QuantityModifier,
+    ClueScrollBoost,
+    SuperiorUniqueBoost,
+    BonusSlayerExp,
+    ThirdTaskChoice,
+];
+/**
+ * Get every Mortifier unlocked for a player with the given number of tasks completed with Mortimer.
+ */
+export function getAvailableMortifiers(completedTasks) {
+    return MORTIFIERS.filter(mortifier => mortifier.isUnlockedAt(completedTasks));
+}
+/**
+ * Get a single Mortifier by its name (case insensitive).
+ */
+export function getMortifierByName(name) {
+    const normalized = name.toLowerCase();
+    return MORTIFIERS.find(mortifier => mortifier.name.toLowerCase() === normalized);
+}