osrs-tools 0.1.1 → 0.2.0

package/src/index.ts

@@ -1,438 +1,11 @@
-// import { QuestTool } from './questTool.js';const { QuestTool } = require('./utils/QuestTool.js')
-// const { OsrsAccount } = require('./utils/OsrsAccount.js');
+// import { QuestTool } from './questTool.js';
+import { QuestTool } from './model/quest/QuestTool';
+import { SlayerTool } from './model/slayer/SlayerTool';
+import { OsrsAccount } from './model/account/OsrsAccount';
 
-import { OsrsAccount } from './utils/OsrsAccount';
-import { QuestTool } from './utils/QuestTool';
-import { QuestData } from './data/quest/questData';
-import { QuestArray } from './data/quest/questDataArray';
-import { SubQuestArray } from './data/quest/subQuestArray';
-
-/**
- * Returns the highest boost for the specified skillName
- * @deprecated
- */
-function highestBoost(skillName: string) {
-  /**
-   * List of highest boostable levels with skills including spicy stew etc
-   */
-  switch (skillName) {
-    case 'construction':
-      // spicy stew + crystal saw
-      return 8;
-    case 'strength':
-      //spicy stew 5
-      // Drunk dragon 1-7
-      // Premade dr'dragon	1-7
-      return 7;
-    case 'thieving':
-    case 'woodcutting':
-    case 'hunter': // spicy stew
-    case 'magic': // 	Imbued heart 10
-    //spicy stew 5
-    case 'hitpoints':
-    //	Guthix rest	5
-    // Anglerfish
-    //Abidor Crank	15
-    // Amulet of the damned	10
-    case 'mining': // spicy stew
-    case 'prayer': // spicy stew
-    case 'ranged': // spicy stew
-    case 'runecraft': //spicy stew 5
-    case 'slayer': //spicy stew 5
-    case 'smithing': //spicy stew 5
-    case 'cooking': // spicy stew
-    case 'crafting': // spicy stew
-    case 'defence': //spicy stew 5
-    case 'farming': // spicy stew
-    case 'firemaking': // spicy stew
-    case 'fishing': // spicy stew
-    case 'fletching': // spicy stew
-    case 'herblore': // spicy stew
-    case 'agility':
-    // spicy stew
-    case 'attack':
-      //spicy stew
-      return 5;
-    default:
-      break;
-  }
-}
-
-var osrsAccount: any;
-
-/**
- * Assign a OSRS account to this package.
- * @deprecated
- */
-function setOsrsAccount(acc: any) {
-  osrsAccount = acc;
-}
-
-/**
- * Assign a OSRS account to this package.
- * @deprecated
- */
-function getOsrsAccount() {
-  return osrsAccount;
-}
-
-/**
- * Returns a json object of all old school runescape quests.
- * @deprecated
- */
-function getQuestObject() {
-  return QuestData;
-}
-
-/**
- * Returns an array object of all old school runescape quests as json objects.
- * @deprecated
- */
-function getQuestArray() {
-  return QuestArray;
-}
-
-/**
- * Returns an array object of all subquests for all old school runescape quests as json objects.
- * @deprecated
- */
-function subQuestArray() {
-  return SubQuestArray;
-}
-
-function hello() {
-  console.log('if you need help use the .help() method');
-  console.log('This is a message from the demo package');
-}
-
-function contact() {
-  console.log(
-    'If you need to contact me feel free to reach out to me at jamesmcerniglia@gmail.com'
-  );
-}
-
-function help() {
-  console.log(
-    'import q from "osrs-quest-tool";\n console.log(q.questObject());\n console.log(q.questArray());'
-  );
-}
-
-// function meetQuestRequirements(quest, account: OsrsAccount) {
-//   if (quest === 'Recipe for Disaster') {
-//     // TODO
-//     // Pirate Pete Subquest of Recipe for Disaster
-//     return true;
-//   } else if (quest === 'Pirate Pete subquest of Recipe for Disaster') {
-//     // TODO
-//     // Pirate Pete Subquest of Recipe for Disaster
-//     return true;
-//   }
-//   //check to see if the account can fulfill all skill requirements
-//   if (quest.requirements.levels) {
-//     for (var x in quest.requirements.levels) {
-//       var cur = quest.requirements.levels[x];
-//       /**
-//        *  cur.level
-//        *  cur.skill
-//        *  cur.boostable
-//        *  cur.ironman
-//        *  types:
-//        *  "quest", "combat", "agility"...
-//        *  */
-
-//       //  If the requirement is mandatory for ironmen
-//       if (cur.ironman && cur.ironman == true) {
-//         if (cur.boostable) {
-//           // Can boost with spicy stew
-//           if (
-//             account.main.skills[cur.skill] + highestBoost(cur.skill) <
-//             cur.level
-//           ) {
-//             return false;
-//           }
-//         } else {
-//           if (account.main.skills[cur.skill] < cur.level) {
-//             return false;
-//           }
-//         }
-//       }
-//       // If the requirement is quest points, check to see if the account has the quest points to complete it
-//       if (cur.skill === 'quest') {
-//         if (account.main.questPoints < cur.level) {
-//           return false;
-//         }
-
-//         // if the requirement is combat level to start the quest, check to see if the account's combat level is higher than or equal to the requirement
-//       } else if (cur.skill === 'combat') {
-//         if (account.main.combatLevel < cur.level) {
-//           return false;
-//         }
-
-//         // If this is ANY skill agility, runecraft, woodcutting, slayer, attack, defence, hitpoints, mining smithing, herblore, fletching, ranged, magic
-//       } else {
-//         // if the requirement is boostable
-//         if (cur.boostable) {
-//           // check if max stew can reach
-//           if (
-//             account.main.skills[cur.skill] + highestBoost(cur.skill) <
-//             cur.level
-//           ) {
-//             return false;
-//           }
-
-//           // if not boostable, check to see if the skill is higher than or equal to
-//         } else {
-//           if (account.main.skills[cur.skill] < cur.level) {
-//             return false;
-//           }
-//         }
-//       }
-//     }
-//   }
-
-//   // Check for all quest requirements
-//   // recursive method called
-//   if (quest.requirements.quests) {
-//     for (var y in quest.requirements.quests) {
-//       // If any of the quests required are not completeable: return false
-//       if (
-//         this.meetQuestRequirements(
-//           this.questObject[quest.requirements.quests[y]]
-//         ) != true
-//       ) {
-//         return false;
-//       }
-//     }
-//   }
-
-//   // If the account can complete all quests and skills are higher than or boostable
-//   return true;
-// }
-
-/**
- *
- * @param {*} quest - The quest object from this modules questObject, should be a Json object.
- * @param {*} account - The account that this quest is being compared to. Plans to remove this in the future?
- * @deprecated - Should use the QuestTool class for this;
- * Recursive method that iterates through a quests requirements that determines the quest is completable with the passed account
- * Possible revamp to remove account param to increase runtime?
- *
- */
-// function canCompleteQuest(quest, account) {
-//   if (quest.name === 'Recipe for Disaster') {
-//     // TODO
-//     // Pirate Pete Subquest of Recipe for Disaster
-//     return true;
-//   } else if (quest.name === 'Pirate Pete subquest of Recipe for Disaster') {
-//     // TODO
-//     // Pirate Pete Subquest of Recipe for Disaster
-//     return true;
-//   }
-//   //check to see if the account can fulfill all skill requirements
-//   if (quest.requirements.levels) {
-//     for (var x in quest.requirements.levels) {
-//       var cur = quest.requirements.levels[x];
-//       /**
-//        *  cur.level
-//        *  cur.skill
-//        *  cur.boostable
-//        *  cur.ironman
-//        *  types: "quest", "combat", "agility"...
-//        *  */
-
-//       //  If the requirement is mandatory for ironmen
-//       if (cur.ironman && cur.ironman == true) {
-//         if (cur.boostable) {
-//           // Can boost with highest boost
-//           if (
-//             account.main.skills[cur.skill] + highestBoost(cur.skill) <
-//             cur.level
-//           ) {
-//             return false;
-//           }
-//         } else {
-//           if (account.main.skills[cur.skill] < cur.level) {
-//             return false;
-//           }
-//         }
-//       }
-//       // If the requirement is quest points, check to see if the account has the quest points to complete it
-//       if (cur.skill === 'quest') {
-//         if (account.main.questPoints < cur.level) {
-//           return false;
-//         }
-
-//         // if the requirement is combat level to start the quest, check to see if the account's combat level is higher than or equal to the requirement
-//       } else if (cur.skill === 'combat') {
-//         if (account.main.combatLevel < cur.level) {
-//           return false;
-//         }
-
-//         // If this is ANY skill agility, runecraft, woodcutting, slayer, attack, defence, hitpoints, mining smithing, herblore, fletching, ranged, magic
-//       } else {
-//         // if the requirement is boostable
-//         if (cur.boostable) {
-//           // check if max stew can reach
-//           if (
-//             account.main.skills[cur.skill] + highestBoost(cur.skill) <
-//             cur.level
-//           ) {
-//             return false;
-//           }
-
-//           // if not boostable, check to see if the skill is higher than or equal to
-//         } else {
-//           if (account.main.skills[cur.skill] < cur.level) {
-//             return false;
-//           }
-//         }
-//       }
-//     }
-//   }
-
-//   // Check for all quest requirements
-//   // recursive method called
-//   if (quest.requirements.quests && quest.requirements.quests >= 1) {
-//     for (var y in quest.requirements.quests) {
-//       // If any of the quests required are not completeable: return false
-//       if (
-//         canCompleteQuest(this.questObject[quest.requirements.quests[y]]) != true
-//       ) {
-//         return false;
-//       }
-//     }
-//   }
-
-//   //iterate through any subquests and see if we can complete
-//   //this is for future work with Recipe for Disaster
-//   if (quest.subquests && quest.subquests.length >= 1) {
-//     for (var y in quest.subquests) {
-//       // If any of the quests required are not completeable: return false
-//       if (
-//         canCompleteQuest(this.questObject[quest.requirements.subquests[y]]) !=
-//         true
-//       ) {
-//         return false;
-//       }
-//     }
-//   }
-
-//   // If the account can complete all quests and skills are higher than or boostable
-//   return true;
-// }
-
-/**
- *
- * @param quest
- * @param account
- * @deprecated - Should use the QuestTool class for this;
- * @returns
- */
-// function meetsRequirement(quest, account) {
-//   if (quest === 'Recipe for Disaster') {
-//     // TODO
-//     // Pirate Pete Subquest of Recipe for Disaster
-//     return true;
-//   } else if (quest === 'Pirate Pete subquest of Recipe for Disaster') {
-//     // TODO
-//     // Pirate Pete Subquest of Recipe for Disaster
-//     return true;
-//   }
-//   //check to see if the account can fulfill all skill requirements
-//   if (quest.requirements.levels) {
-//     for (var x in quest.requirements.levels) {
-//       var cur = quest.requirements.levels[x];
-//       /**
-//        *  cur.level
-//        *  cur.skill
-//        *  cur.boostable
-//        *  cur.ironman
-//        *  types:
-//        *  "quest", "combat", "agility"...
-//        *  */
-
-//       //  If the requirement is mandatory for ironmen
-//       if (cur.ironman && cur.ironman == true) {
-//         if (cur.boostable) {
-//           // Can boost with spicy stew
-//           if (
-//             account.main.skills[cur.skill] + highestBoost(cur.skill) <
-//             cur.level
-//           ) {
-//             return false;
-//           }
-//         } else {
-//           if (account.main.skills[cur.skill] < cur.level) {
-//             return false;
-//           }
-//         }
-//       }
-//       // If the requirement is quest points, check to see if the account has the quest points to complete it
-//       if (cur.skill === 'quest') {
-//         if (account.main.questPoints < cur.level) {
-//           return false;
-//         }
-
-//         // if the requirement is combat level to start the quest, check to see if the account's combat level is higher than or equal to the requirement
-//       } else if (cur.skill === 'combat') {
-//         if (account.main.combatLevel < cur.level) {
-//           return false;
-//         }
-
-//         // If this is ANY skill agility, runecraft, woodcutting, slayer, attack, defence, hitpoints, mining smithing, herblore, fletching, ranged, magic
-//       } else {
-//         // if the requirement is boostable
-//         if (cur.boostable) {
-//           // check if max stew can reach
-//           if (
-//             account.main.skills[cur.skill] + highestBoost(cur.skill) <
-//             cur.level
-//           ) {
-//             return false;
-//           }
-
-//           // if not boostable, check to see if the skill is higher than or equal to
-//         } else {
-//           if (account.main.skills[cur.skill] < cur.level) {
-//             return false;
-//           }
-//         }
-//       }
-//     }
-//   }
-
-//   // Check for all quest requirements
-//   // recursive method called
-//   if (quest.requirements.quests) {
-//     for (var y in quest.requirements.quests) {
-//       // If any of the quests required are not completeable: return false
-//       if (
-//         meetQuestRequirements(this.questObject[quest.requirements.quests[y]]) !=
-//         true
-//       ) {
-//         return false;
-//       }
-//     }
-//   }
-
-//   // If the account can complete all quests and skills are higher than or boostable
-//   return true;
-// }
-
-export = {
+export default {
   QuestTool,
   OsrsAccount,
-  QuestArray,
-  QuestData,
-  hello,
-  setOsrsAccount,
-  getOsrsAccount,
-  getQuestObject,
-  getQuestArray,
-  contact,
-  help,
-  // meetsRequirement,
-  // canCompleteQuest,
-  subQuestArray,
+  SlayerTool
 };
 // export default

package/src/model/Requirement.ts

@@ -0,0 +1,173 @@
+// Base interface for all types of requirements
+interface Requirement {
+  description: string;
+  isMet(): boolean;
+}
+
+// TODO: Add a requirement type for all "levels" (combat, slayer, farming, crafting etc.)
+class LevelRequirement implements Requirement {
+  type: RequirementType = RequirementType.Level;
+  skillName: string;
+  level: number;
+  boostable: boolean = false; // Indicates if the level can be boosted
+
+  constructor(skillName: string, level: number, boostable: boolean = false) {
+    this.boostable = boostable;
+    this.skillName = skillName;
+    this.level = level;
+  }
+
+  get description(): string {
+    return `Level ${this.level}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check the player's level
+    return false; // TODO
+  }
+}
+
+// Enum for requirement types
+enum RequirementType {
+  SlayerLevel = 'SlayerLevel',
+  Level = 'Level',
+  CombatLevel = 'CombatLevel',
+  Quest = 'Quest',
+  Item = 'Item',
+  Location = 'Location',
+  SlayerUnlock = 'SlayerUnlock',
+}
+
+// Slayer Unlock requirement
+class SlayerUnlockRequirement implements Requirement {
+  type: RequirementType = RequirementType.SlayerUnlock;
+  name: string;
+
+  constructor(name: string) {
+    this.name = name;
+  }
+  get description(): string {
+    return `Slayer unlock: ${this.name}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check the player's Slayer level
+    return false; // TODO
+  }
+}
+
+// Slayer level requirement
+class SlayerLevelRequirement implements Requirement {
+  type: RequirementType = RequirementType.SlayerLevel;
+  level: number;
+
+  constructor(level: number) {
+    this.level = level;
+  }
+
+  get description(): string {
+    return `Slayer level ${this.level}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check the player's Slayer level
+    return false; // TODO
+  }
+}
+
+// Combat level requirement
+class CombatLevelRequirement implements Requirement {
+  type: RequirementType = RequirementType.CombatLevel;
+  level: number;
+
+  constructor(level: number) {
+    this.level = level;
+  }
+
+  get description(): string {
+    return `Combat level ${this.level}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check the player's Combat level
+    return false; // TODO
+  }
+}
+
+// Quest requirement
+class QuestRequirement implements Requirement {
+  type: RequirementType = RequirementType.Quest;
+  questName: string;
+
+  constructor(questName: string) {
+    this.questName = questName;
+  }
+
+  get description(): string {
+    return `Completed quest: ${this.questName}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check if the quest is completed
+    return false; // TODO
+  }
+}
+
+// Item requirement
+class ItemRequirement implements Requirement {
+  type: RequirementType = RequirementType.Item;
+  itemName: string;
+
+  constructor(itemName: string) {
+    this.itemName = itemName;
+  }
+
+  get description(): string {
+    return `Has item: ${this.itemName}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check if the player has the item
+    return false; // TODO
+  }
+}
+
+// Location requirement
+class LocationRequirement implements Requirement {
+  type: RequirementType = RequirementType.Location;
+  locationName: string;
+
+  constructor(locationName: string) {
+    this.locationName = locationName;
+  }
+
+  get description(): string {
+    return `Access to location: ${this.locationName}`;
+  }
+
+  isMet(): boolean {
+    // Replace with actual logic to check if the player is in the location
+    return false; // TODO
+  }
+}
+
+// Example usage: Array of requirements for a monster
+const monsterRequirements: Requirement[] = [
+  new SlayerLevelRequirement(44),
+  new CombatLevelRequirement(5),
+  new QuestRequirement('Dragon Slayer'),
+  new ItemRequirement('Anti-dragon shield'),
+  new LocationRequirement('Taverley Dungeon'),
+];
+
+export {
+  Requirement,
+  RequirementType,
+  SlayerLevelRequirement,
+  CombatLevelRequirement,
+  QuestRequirement,
+  ItemRequirement,
+  LocationRequirement,
+  SlayerUnlockRequirement,
+  LevelRequirement,
+};

package/src/model/account/OsrsAccount.ts

@@ -0,0 +1,82 @@
+interface OsrsAccountObject {
+    name: string;
+    main: {
+        combatLevel: number;
+        questPoints: number;
+        skills: {
+            [skillName: string]: {
+                level: number;
+            };
+        };
+    };
+}
+
+class OsrsAccount {
+    private osrsAccount: OsrsAccountObject | null;
+
+    constructor(accountObject: OsrsAccountObject | null) {
+        this.osrsAccount = accountObject ? accountObject : null;
+        this.setQuestPoints(0);
+        this.setCombatLevel();
+    }
+
+    getName(): string | undefined {
+        return this.osrsAccount?.name;
+    }
+
+    toString(): string {
+        return (
+            (this.osrsAccount?.name ?? "") +
+            ":  \nCombat Level: " +
+            (this.osrsAccount?.main.combatLevel ?? "") +
+            "\nQuestPoints: " +
+            this.getQuestPoints()
+        );
+    }
+
+    getSkills(): { [skillName: string]: { level: number } } | undefined {
+        return this.osrsAccount?.main.skills;
+    }
+
+    getSkill(skillName: string): { level: number } | undefined {
+        return this.osrsAccount?.main.skills[skillName.toLowerCase()];
+    }
+
+    getQuestPoints(): number | undefined {
+        return this.osrsAccount?.main.questPoints;
+    }
+
+    setQuestPoints(x: number): void {
+        if (x >= 0 && this.osrsAccount) {
+            this.osrsAccount.main.questPoints = x;
+        }
+    }
+
+    getCombatLevel(): number | undefined {
+        return this.osrsAccount?.main.combatLevel;
+    }
+
+    setCombatLevel(): void {
+        if (this.osrsAccount) {
+            const attklvl = this.osrsAccount.main.skills.attack?.level ?? 1;
+            const strlvl = this.osrsAccount.main.skills.strength?.level ?? 1;
+            const deflvl = this.osrsAccount.main.skills.defence?.level ?? 1;
+            const rangedlvl = this.osrsAccount.main.skills.ranged?.level ?? 1;
+            const magiclvl = this.osrsAccount.main.skills.magic?.level ?? 1;
+            const praylvl = this.osrsAccount.main.skills.prayer?.level ?? 1;
+            const hplvl = this.osrsAccount.main.skills.hitpoints?.level ?? 10;
+            const x = [
+                0.325 * (attklvl + strlvl),
+                0.325 * ((3 * rangedlvl) / 2),
+                0.325 * ((3 * magiclvl) / 2),
+            ];
+            const cbMax = Math.max(...x);
+
+            this.osrsAccount.main.combatLevel =
+                0.25 * (deflvl + hplvl + praylvl / 2) + cbMax
+                ;
+        }
+    }
+}
+
+export { OsrsAccount };