Skip to content

jamescer/osrs-tools

Repository files navigation

Old School RuneScape Quest Tool

NPM Version Downloads GitHub Issues

A Node.js package to provide data for all current Old School RuneScape quests. The tool aims to help junior software developers build projects they are passionate about. It's a work in progress, and issues can be reported to jamesmcerniglia@gmail.com or under the issues tab on GitHub.

Installation

npm install osrs-tools --save

Usage

import { QuestTool, questArray, questObject } from "osrs-quest-tool";

const tool = new QuestTool();
const questArrayData = questArray();
const questObjectData = questObject();

console.log(questObjectData);
console.log(questArrayData);

API

Method Description Type
new QuestTool() Constructor for the QuestTool class. Class Constructor
questObject() Function that returns an object of quest array keys. Function
questArray() Function that returns an array of alphabetically ordered quests. Function

Core Concept

The core concept of this tool is to provide an easy-to-use module and API for accessing Old School RuneScape quest data.

To-Do

  • Implement a recursive function for determining quest completion
  • Implement a quest completion array
  • Implement questArray and questObject objects instead of functions
  • Recipe for Disaster is a work in progress!

Credits