osrs-tools 0.1.1 → 0.2.0

package/src/utils/AchievementDiary.ts

@@ -1,18 +0,0 @@
-
-import { Requirement  QuestRequirement,
-  SkillRequirement, } from './Requirement';
-
-/**
- * AchievementDiary class
- * Author: James Cerniglia
- */
-
-export class AchievementDiary {
-
-  rewards:Object;
-
-  constructor() {
-    
-  }
-}
-

package/src/utils/Farming/FarmingTool.ts

@@ -1,110 +0,0 @@
-import { OsrsAccount } from '../OsrsAccount';
-import { subQuestArray } from '../../data/quest/subQuestArray';
-const questData = require('../../data/quest/questData.js');
-const questDataArray = require('../data/questDataArray.js');
-const trees = require('../data/farming/tree.json');
-const fruitTrees = require('../../data/farming/fruitTrees.json');
-const { Seed } = require('./Seed.js');
-
-class FarmingTool {
-  osrsAccount: OsrsAccount;
-  trees: any;
-  fruitTrees: any;
-  constructor(osrsAccount) {
-    this.osrsAccount = acc1 != null ? new OsrsAccount(acc1) : null;
-    this.trees = questDataArray;
-    this.fruitTrees = subQuestArray;
-  }
-  /**
-   * to string func
-   * @todo Possibly return all methods etc with descriptions
-   * */
-  toString() {
-    return 'FarmingTool :) WIP';
-  }
-
-  /**
-   * Set the account to be used in this quest tool
-   * @param  {} skillName The osrs Account to be associated with this class object.
-   * */
-  getTreeRun() {
-    if (this.hasOsrsAccount()) {
-      return false;
-    } else {
-      //Lets get levels for tree run
-      var level = this.osrsAccount.getFarmingLevel();
-    }
-  }
-  /**
-   * Set the account to be used in this quest tool
-   * @param  {} skillName The osrs Account to be associated with this class object.
-   * */
-  getItemsForSeed(seed: Seed) {}
-
-  /**
-   * getFruitTreeRun
-   */
-  getFruitTreeRun() {
-    if (this.hasOsrsAccount()) {
-      return false;
-    } else {
-      var level = this.osrsAccount.getFarmingLevel();
-    }
-  }
-
-  /**
-   * getCombinedTreeRun
-   * */
-  getCombinedTreeRun() {
-    if (this.hasOsrsAccount()) {
-      return false;
-    } else {
-      var level = this.osrsAccount.getFarmingLevel();
-    }
-  }
-
-  /**
-   * Set the account to be used in this quest tool
-   * @param  {Object} skillName The osrs Account to be associated with this class object.
-   * */
-  setOsrsAccount(acc1) {
-    if (acc1) {
-      this.osrsAccount = new OsrsAccount(acc1);
-      return true;
-    } else {
-      return false;
-    }
-  }
-
-  /**
-   * Set the account to be used in this quest tool
-   * @param  {Object} skillName The osrs Account to be associated with this class object.
-   * */
-  setAccount(acc1) {
-    if (acc1) {
-      this.osrsAccount = new OsrsAccount(acc1);
-    }
-  }
-  /**
-   * if the tool has an osrsaccount associated with
-   * @return  {Boolean}
-   * */
-  hasOsrsAccount() {
-    if (this.osrsAccount != null && this.osrsAccount) {
-      return true;
-    } else {
-      return false;
-    }
-  }
-
-  /**
-   * Set the account to be used in this quest tool
-   * @return  {OsrsAccount} osrsAccount The osrs Account to be associated with this class object.
-   * */
-  getOsrsAccount() {
-    return this.osrsAccount;
-  }
-}
-
-module.exports = { FarmingTool };
-// exports.QuestTool = QuestTool;

package/src/utils/Farming/Seed.js

@@ -1,42 +0,0 @@
-const seeds = require('../../data/farming/seeds.json'); //list of all seeds
-
-class Seed {
-  seed;
-  constructor({ name, level, xp, type }) {
-    this.name = name;
-    this.level = level;
-    this.xp = xp;
-    this.type = type;
-  }
-
-  getSeedAmount() {
-    let seedAmount = 1;
-    switch (this.type.toLowerCase()) {
-      case 'flower':
-      case 'tree':
-      case 'herb':
-        seedAmount = 1;
-        break;
-      case 'allotment':
-        seedAmount = 3;
-        break;
-      default:
-        seedAmount = 1;
-        break;
-    }
-    return seedAmount;
-  }
-  getLevel() {
-    return this.level > 1 ? this.level : 1;
-  }
-
-  getRequiredLevel() {
-    return this.level > 1 ? this.level : 1;
-  }
-}
-
-module.exports = {
-  seedlist: seeds,
-  seeds: seeds,
-  Seed: Seed,
-};

package/src/utils/Farming/TreeSeed.js

@@ -1,21 +0,0 @@
-const treeSeeds = require('../../data/farming/trees.json');
-const fruitTreeSeeds = require('../../data/farming/fruitTrees.json');
-
-class TreeSeed extends Seed {
-  constructor(seed) {
-    this.seed = seed;
-  }
-
-  getProtection() {
-    this.seed.protection;
-  }
-  getProtection() {
-    this.seed.uses;
-  }
-}
-
-module.exports = {
-  TreeSeed: TreeSeed,
-  treeSeeds: treeSeeds,
-  fruitTreeSeeds: fruitTreeSeeds,
-};

package/src/utils/OsrsAccount.ts

@@ -1,280 +0,0 @@
-import { Skill } from './Skill';
-
-export interface OsrsAccountObject {
-  osrsAccount: object;
-
-  main: {
-    questPoints: number;
-    combatLevel: number;
-    skills: {
-      overall: SkillObject;
-      attack: SkillObject;
-      defence: SkillObject;
-      strength: SkillObject;
-      hitpoints: SkillObject;
-      ranged: SkillObject;
-      prayer: SkillObject;
-      magic: SkillObject;
-      cooking: SkillObject;
-      woodcutting: SkillObject;
-      fletching: SkillObject;
-      fishing: SkillObject;
-      firemaking: SkillObject;
-      crafting: SkillObject;
-      smithing: SkillObject;
-      mining: SkillObject;
-      herblore: SkillObject;
-      agility: SkillObject;
-      thieving: SkillObject;
-      slayer: SkillObject;
-      farming: SkillObject;
-      runecraft: SkillObject;
-      hunter: SkillObject;
-      construction: SkillObject;
-    };
-  };
-  name: string;
-  combatLevel: number;
-}
-
-export interface SkillObject {
-  rank: number;
-  level: number;
-  xp: number;
-}
-
-/**
- * OsrsAccount
- * Author: James Cerniglia
- */
-export class OsrsAccount {
-  osrsAccount: OsrsAccountObject;
-
-  main: {
-    questPoints: number;
-    combatLevel: number;
-    skills: {
-      overall: SkillObject;
-      attack: SkillObject;
-      defence: SkillObject;
-      strength: SkillObject;
-      hitpoints: SkillObject;
-      ranged: SkillObject;
-      prayer: SkillObject;
-      magic: SkillObject;
-      cooking: SkillObject;
-      woodcutting: SkillObject;
-      fletching: SkillObject;
-      fishing: SkillObject;
-      firemaking: SkillObject;
-      crafting: SkillObject;
-      smithing: SkillObject;
-      mining: SkillObject;
-      herblore: SkillObject;
-      agility: SkillObject;
-      thieving: SkillObject;
-      slayer: SkillObject;
-      farming: SkillObject;
-      runecraft: SkillObject;
-      hunter: SkillObject;
-      construction: SkillObject;
-    };
-  };
-  name: string;
-  combatLevel: number;
-
-  constructor(accountObject: OsrsAccountObject) {
-    // uses an account under the schema returned from const osrshiscores = require('osrs-json-hiscores');
-    this.osrsAccount = accountObject ?? null;
-    this.setQuestPoints(0);
-    this.setCombatLevel();
-  }
-
-  toString() {
-    return (
-      this.osrsAccount.name +
-      ':  \nCombat Level: ' +
-      this.osrsAccount.main.combatLevel +
-      '\nQuestPoints: ' +
-      this.getQuestPoints()
-    );
-  }
-
-  /**
-   * Get Skills for account
-   * @return {Array} The array of skills associated with this account
-   */
-  getSkills() {
-    return this.osrsAccount.main.skills;
-  }
-
-  /**
-   * Get Quest Points for account
-   * @return {Number} The amount of quest points for this account
-   */
-  getQuestPoints() {
-    return this.osrsAccount.main.questPoints;
-  }
-
-  /**
-   * Set Quest Points for account
-   * @param {Number} x integer that is greater than or equal to 0, cannot put < 0
-   */
-  setQuestPoints(x) {
-    if (x >= 0) {
-      this.osrsAccount.main.questPoints = x;
-    } else {
-      this.osrsAccount.main.questPoints = 0;
-    }
-  }
-  /**
-   * Get Combat Level for account
-   * @return {Number} The combat level for this account
-   */
-  getCombatLevel() {
-    return this.osrsAccount.main.combatLevel;
-  }
-
-  /**
-   * Set Combat Level for account
-   */
-  setCombatLevel() {
-    var attklvl = this.osrsAccount.main.skills.attack.level ?? 1;
-    var strlvl = this.osrsAccount.main.skills.strength.level ?? 1;
-    var deflvl = this.osrsAccount.main.skills.defence.level ?? 1;
-    var rangedlvl = this.osrsAccount.main.skills.ranged.level ?? 1;
-    var magiclvl = this.osrsAccount.main.skills.magic.level ?? 1;
-    var praylvl = this.osrsAccount.main.skills.prayer.level ?? 1;
-    var hplvl = this.osrsAccount.main.skills.hitpoints.level ?? 10;
-    var x = [
-      Number(0.325 * (attklvl + strlvl)),
-      Number(0.325 * ((3 * rangedlvl) / 2)),
-      Number(0.325 * ((3 * magiclvl) / 2)),
-    ];
-    var cbMax = Math.max.apply(Math, x);
-    var cb = parseInt(0.25 * (deflvl + hplvl + praylvl / 2) + cbMax);
-    this.osrsAccount.main.combatLevel = cb;
-    return true;
-  }
-
-  /**
-   * Get Skill level for key input
-   * @return {Number} The combat level for this account\
-   * Example: "getSkillLevel('farming'"
-   */
-  getSkillLevel(skillName) {
-    if (skillName) {
-      var skillLowercase = skillName.toLowerCase();
-      if (this.osrsAccount.main.skills[skillLowercase].level) {
-        return this.osrsAccount.main.skills[skillLowercase].level;
-      } else {
-        console.log('No SkillName found for ' + skillName);
-        return false;
-      }
-    }
-    console.log('No SkillName found for ' + skillName);
-    return false;
-  }
-
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getAttackLevel() {
-    if (this.osrsAccount.main.skills.attack.level) {
-      return this.osrsAccount.main.skills.attack.level;
-    }
-    console.log('No attack found for ' + this.osrsAccount.name);
-    return false;
-  }
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getStrengthLevel() {
-    if (this.osrsAccount.main.skills.strength.level) {
-      return this.osrsAccount.main.skills.strength.level;
-    }
-    console.log('No strength found for ' + this.osrsAccount.name);
-    return false;
-  }
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getDefenceLevel() {
-    if (this.osrsAccount.main.skills.defence.level) {
-      return this.osrsAccount.main.skills.defence.level;
-    }
-    console.log('No defence found for ' + this.osrsAccount.name);
-    return false;
-  }
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getRangedLevel() {
-    if (this.osrsAccount.main.skills.ranged.level) {
-      return this.osrsAccount.main.skills.ranged.level;
-    }
-    console.log('No ranged found for ' + this.osrsAccount.name);
-    return false;
-  }
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getPrayerLevel() {
-    if (this.osrsAccount.main.skills.prayer.level) {
-      return this.osrsAccount.main.skills.prayer.level;
-    }
-    console.log('No prayer found for ' + this.osrsAccount.name);
-    return false;
-  }
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getMagicLevel() {
-    if (this.osrsAccount.main.skills.prayer.level) {
-      return this.osrsAccount.main.skills.prayer.level;
-    }
-    console.log('No prayer found for ' + this.osrsAccount.name);
-    return false;
-  }
-
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getRunecraftingLevel() {
-    if (this.osrsAccount.main.skills.runecraft.level) {
-      return this.osrsAccount.main.skills.runecraft.level;
-    }
-    console.log('No runecraft found for ' + this.osrsAccount.name);
-    return false;
-  }
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getConstructionLevel() {
-    if (this.osrsAccount.main.skills.construction.level) {
-      return this.osrsAccount.main.skills.construction.level;
-    }
-    console.log('No construction found for ' + this.osrsAccount.name);
-    return false;
-  }
-
-  /**
-   * Get Skill level for key input
-   * Example: "getFarmingLevel()
-   */
-  getHitpointsLevel() {
-    if (this.osrsAccount.main.skills.hitpoints.level) {
-      return this.osrsAccount.main.skills.hitpoints.level;
-    }
-    console.log('No hitpoints found for ' + this.osrsAccount.name);
-    return false;
-  }
-}

package/src/utils/Quest.ts

@@ -1,99 +0,0 @@
-import { Requirement, QuestRequirement, SkillRequirement } from './Requirement';
-
-/**
- * Quest class
- * Author: James Cerniglia
- */
-export enum QuestSeries {
-  Up = 'UP',
-  Down = 'DOWN',
-  Left = 'LEFT',
-  Right = 'RIGHT',
-}
-
-export interface QuestObject {
-  isMembers: Boolean;
-  isSubquest: Boolean;
-  isMiniquest: Boolean;
-  name: String;
-  shortName: String;
-  url: String;
-  itemsRecommended: Array<String>;
-  enemiesToDefeat: Array<String>;
-  itemsRequired: Array<String>;
-  startPoint: String;
-  description: String;
-  difficulty: String;
-  questLength: String;
-  series: String;
-  subquests: Array<QuestObject>;
-  requirements: any;
-  rewards: object;
-}
-
-export class Quest {
-  questObject: object;
-  isMembers: Boolean;
-  isSubquest: Boolean;
-  isMiniquest: Boolean;
-  name: String;
-  shortName: String;
-  url: String;
-  itemsRecommended: Array<String>;
-  enemiesToDefeat: Array<String>;
-  itemsRequired: Array<String>;
-  startPoint: String;
-  description: String;
-  difficulty: String;
-  questLength: String;
-  series: String;
-  subquests: Array<QuestObject>;
-  requirements: any;
-  rewards: object;
-  constructor(questObject: QuestObject) {
-    this.questObject = questObject;
-    this.name = questObject.name;
-    this.isMiniquest = questObject.isMiniquest;
-    this.isSubquest = questObject.isSubquest;
-    this.isMembers = questObject.isMembers;
-    this.shortName = questObject.shortName;
-    this.url = questObject.url;
-    this.difficulty = questObject.difficulty;
-    this.questLength = questObject.questLength;
-    this.series = questObject.series;
-    this.subquests = questObject.subquests;
-    this.requirements = questObject.requirements;
-    this.rewards = questObject.rewards;
-    this.startPoint = questObject.startPoint;
-    this.description = questObject.description;
-    this.itemsRequired = questObject.itemsRequired;
-    this.enemiesToDefeat = questObject.enemiesToDefeat;
-    this.itemsRecommended = questObject.itemsRecommended;
-    // Initialize quest requirements
-
-    if (this.requirements?.quests) {
-      for (var req in this.requirements.quests) {
-        this.requirements.quests.push(
-          new QuestRequirement(this.requirements.quests[req])
-        );
-      }
-    }
-
-    if (this.requirements?.skills) {
-      for (var req in this.requirements.quests) {
-        this.requirements.push(
-          new SkillRequirement(this.requirements.quests[req])
-        );
-      }
-    }
-  }
-
-  /**
-   *
-   * @returns {String} string description of class
-   */
-  toString() {
-    return this.name;
-  }
-}
-export class SubQuest extends Quest {}