osrsbox 1.0.0

A complete and up-to-date database of Old School RuneScape (OSRS) items.

osrsbox-db

A complete and up-to-date database of Old School Runescape (OSRS) items

This repository hosts a complete and up-to-date database of OSRS items. Complete means it holds every single items in OSRS. Up-to-date means this database is updated after every weekly game update to ensure accurate information. Current development is working towards adding a similar database for monsters and quests.

For more user-friendly information see:

• https://www.osrsbox.com/projects/osrsbox-db/
• https://www.osrsbox.com/blog/tags/Database/

Summary of Project Structure

• data: Collection of useful data files used in the osrsbox-db project.
• docs: The publicly accessible item database available through this repo or a somewhat-RESTful API. This folder contains the actual item database that is publicly available, or browsable within this repository.
• extraction_tools_cache: An up-to-date OSRS cache dump (compressed) with associated tools used in other parts in this project.
• extraction_tools_other: Collection of Python tools to extract data from a variety of sources including equipable item skill requirements, grand exchange buy limits, and name normalization for more efficient OSRS Wiki lookups.
• extraction_tools_wiki: Collection of Python modules to extract data from the new (non-Wikia) OSRS Wiki site. There is also dumped data (category page titles and raw wiki text) for items, quests and monsters that is somewhat-regularly updated.
• items_builder: Collection of Python scripts to build the item database. The builder.py script is the primary entry point.
  • update_tools: Scripts used to update all data files after each weekly game update.
• osrsbox: The future Python package:
  • items_api: The Python API for interacting with the items database. Has modules to load all items in the database, iterate through items and access the different item properties.
  • items_tools: A collection of simple Python scripts that use the items_api to provide an example of what can be achieved and how to use the items database.
• test: A collection of unit tests
• CHANGELOG_items.md: Document of items added, removed or changed in each weekly game update that have been added to the database.