RS3 Companion

A lightweight desktop overlay for RuneScape 3 that helps you track dailies, manage timers, and find profitable Grand Exchange flips.

Features

• Daily Tracker — Track daily challenges, missions, farming runs, and Miscellania with auto-reset at UTC midnight
• Grand Exchange Tool — Search item prices, view trends, calculate flip margins, and get suggestions for profitable items
• Overlay Mode — Transparent, always-on-top window that sits over your game; toggle with Alt+R

Tech Stack

• Tauri v2 — Rust backend + lightweight native window
• Svelte 5 — TypeScript frontend
• SQLite — Local data persistence
• WeirdGloop API + RuneMetrics — RS3 game data

Getting Started

Prerequisites

• Node.js (v18+)
• Rust (stable)
• Tauri prerequisites for your OS

Development

npm install
npm run tauri dev

Build

npm run tauri build

This produces a .msi installer in src-tauri/target/release/bundle/.

Project Structure

RS3-Companion/
├── src/                  # Svelte frontend
│   ├── App.svelte        # Root overlay component
│   ├── main.ts           # Entry point
│   └── lib/              # Stores, types, utilities
├── src-tauri/            # Rust backend
│   ├── src/              # Tauri commands & services
│   ├── tauri.conf.json   # Window & app configuration
│   └── Cargo.toml        # Rust dependencies
└── package.json

License

This project is licensed under the GNU General Public License v3.0.