Skip to main content

A package to help developers access a structured form of runescape quests

Project description

OSRS QuestTool Build Status Coverage Status Maintainability Test Coverage

A collection of quest data in order to help developers create something special. Also includes a Python class QuestTool in order for pip installers to access and use this repository.

Installation

pip install osrsquesttool

Example

from QuestTool import QuestTool
qt = QuestTool('jimbo jango', 300)
#QuestTool('ACCOUNT_NAME', QUEST_POINT_AMOUNT)
qt.meetsRequirements('Regicide')
qt.getRequirements('One Small Favour')
doable = qt.getDoableQuests()

Methods

x = qt.meetsRequirements('Regicide')

Used to see if the character associated with the Quest Tool is able to complete the quest input. Returns a boolean

print(x)
True

x = qt.getRequirements('One Small Favour')

Used to get individual quest requirements. Returns a dictionary object

{
    "skills": {
        "agility": 36,
        "crafting": 25,
        "herblore": 18,
        "smithing": 30
    },
    "quests": {
        "Rune Mysteries": {
            "skills": {},
            "quests": {}
        },
        "Shilo Village": {
            "skills": {
                "crafting": 20,
                "agility": 32,
                "smithing": 4
            },
            "quests": {}
        }
    }
}

z = qt.getDoableQuests()

Used to get all quests that can be done with the associated account (includes boosts). Returns a dictionary object

{
    "A Soul's Bane": True,
    "A Tail of Two Cats" True,
    "Animal Magnetism" True,
    "Big Chompy Bird Hunting" True,
    "Biohazard" True,
    "Black Knights' Fortress": True,
    "Bone Voyage" True,
    "Client of Kourend" True,
    "Clock Tower" True,
    "Contact!" True,
    .
    .
    .
    "Waterfall Quest" True,
    "What Lies Below" True,
    "Witch's House": True,
    "Witch's Potion": True
}


# TODO
- Must restructure Recipe for Disaster subsection and find proper structure for the subquests it involves
- Must add new quests like Song of the Elves, Fremnick Exiles (cannot find old api I snagged data from) to the api

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for OSRSQuestTool, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size OSRSQuestTool-0.0.3.tar.gz (2.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page