Skip to main content

​
RuneLite Framework

Open source Old School RuneScape client with a powerful plugin system for game enhancements

​
What is RuneLite?

RuneLite is a free, open-source client for Old School RuneScape that provides a powerful framework for building game enhancements through plugins. With over 130 built-in plugins and support for external plugins, RuneLite enables developers to create custom features that enhance the OSRS experience.

Plugin System

Build custom plugins with a simple lifecycle and dependency injection

Rich API

Access comprehensive game data through a clean, well-documented API

Event-Driven

React to game events with a powerful EventBus architecture

UI Overlays

Render custom overlays on top of the game interface

​
Key Features

RuneLite comes with 130+ built-in plugins covering everything from skill calculators to PvM helpers. Each plugin is independently managed and can be toggled on or off based on user preferences.
Access all aspects of the game through clean Java interfaces - Players, NPCs, Items, GameObjects, Widgets, and more. The API abstracts away the complexity of the deobfuscated game client.
Subscribe to game events like chat messages, item spawns, NPC spawns, and more through a simple EventBus pattern. No polling required.
Create custom UI overlays that render on top of the game. Perfect for displaying timers, highlighting objects, or showing additional information.
Each plugin can define its own configuration with a type-safe API. User settings are automatically persisted and synchronized.
Read game data files directly from the cache - Item definitions, NPC stats, map data, and more.

​
Quick Start

1

Install Java

RuneLite requires Java 11 or higher. Download from AdoptOpenJDK or use your system package manager.
2

Clone the Repository

git clone https://github.com/runelite/runelite.git
cd runelite
3

Open in IntelliJ IDEA

Import the project as a Gradle project. IntelliJ will automatically download dependencies and configure the project.
4

Run the Client

Run the RuneLite class in runelite-client to start the client. You’re ready to start developing!

Full Installation Guide

See detailed setup instructions for all platforms

​
Project Structure

RuneLite is organized into several key modules:

runelite-api

Core API interfaces for accessing the game client

runelite-client

Main client application with built-in plugins

cache

Library for reading and writing OSRS cache files

runelite-gradle-plugin

Gradle plugin for building external plugins

​
Community & Support

GitHub

Contribute to RuneLite on GitHub

Discord

Join the RuneLite Discord community

Wiki

Browse the community wiki

Report Issues

Report bugs and request features

​
License

RuneLite is licensed under the BSD 2-Clause License. See the LICENSE file for details.

Build docs developers (and LLMs) love

Get started for freeTalk to us