osrs-data-hub

Introduction

What osrs-data-hub is, how data flows through it, and where to start.

osrs-data-hub is a self-hostable web app for one Discord guild (clan). It collects Old School RuneScape account data from the HA Exporter RuneLite plugin, keeps long-term history per account, and shares it inside the guild.

  • Receives data from the plugin through a drop-in endpoint for its pairing and ingest protocol. It is the same protocol the Home Assistant integration speaks.
  • Aggregates everything per OSRS account: current state, 10+ years of XP history, events (loot, levels, deaths, collection log, diaries, combat tasks), play sessions, gear, wealth and a location trail.
  • Shows it on a personal dashboard, account pages, a guild page and live event toasts.
  • Shares it with per-account, per-category permissions, plus a pull-only REST API with scoped keys for Home Assistant, a Discord bot, a live map or your own scripts.

Players sign in with Discord. Sign-in is limited to members of your guild, and optionally to members with a given role.

How it fits together

RuneLite + HA Exporter ──pair / events──▶ osrs-data-hub ◀──GET /api/v1/…── integrations
   (every player)                          (your server)              (map, bot, scripts)
                                                 │
                                                 └──▶ web app for guild members (Discord login)
  1. You run one hub for your guild (Docker Compose on a small VM is enough).
  2. Players install HA Exporter from the RuneLite Plugin Hub and pair it with the hub using a 5-digit code. From then on the plugin sends their data while they play.
  3. Owners decide who sees what. Every account has sharing settings per category, and the plugin itself decides what is sent at all.
  4. Integrations read the data through the read-only API with a key. There are no webhooks: integrations poll.

Where to go next

On this page