Download launcher · Client releases · Build it yourself · Write a plugin · API reference
Join our Discord community for release news, plugin development, help, and community showcases.
An open-source desktop client built around extensibility. Explore the world with familiar tools, load community plugins from GitHub, and build your own features with the OpenOSRS API.
Your client. Your plugins. Your source.
- Install Java 11 or newer.
- Download the launcher JAR from OpenOSRS Launcher releases.
- Open it with Java, or run
java -jar openosrs-launcher-1.0.4.jar. - Select Launch OpenOSRS. The launcher downloads and verifies the matching client, then keeps it cached.
Client and launcher updates have separate release channels. Failed downloads preserve existing cached files. A cached client still needs a game-compatible revision and a network connection to play.
You can also download the client JAR directly and run java -jar openosrs-client-1.2.0.jar.
| Surface | What you can build |
|---|---|
| Entity queries | Find NPCs, players, objects, and ground items with readable filters. |
| Inventory and equipment | Inspect items, quantities, slots, and equipment state. |
| Events and overlays | React to game changes and present useful information on screen. |
| Widgets and dialogue | Read interfaces and use available actions through shared services. |
| Movement and world state | Work with paths, tiles, camera state, scenes, and maps. |
| Game services | Use focused helpers for skills, combat, prayer, magic, banking, and more. |
| External repositories | Install independently built plugin JARs through the client’s repository feature. |
The API is accessed through net.openosrs.api.OpenOSRS. For example, from a game event:
int loadedNpcs = OpenOSRS.npcs().all().size();
int coins = OpenOSRS.inventory().count(995);
boolean inventoryFull = OpenOSRS.inventory().isFull();See the plugin guide, API guide, and three example plugins. Versioned Javadocs and source JARs are included in client releases.
Use the Profiles sidebar to add Jagex accounts, save your characters, and select one at the login screen.
git clone https://github.com/OOSRS/OOSRS.git
cd OOSRS
./gradlew :runelite-client:shadowJar
java -jar runelite-client/build/libs/openosrs-client-1.2.0.jarUse a Java 11 JDK. On Windows, use gradlew.bat. The build fetches its pinned game dependency and verifies its SHA-256; you do not need the private maintainer tools. Full build guide →
openosrs-api— OpenOSRS service facade, queries, and interaction helpers.runelite-api— game and plugin compatibility interfaces.runelite-client— desktop client and built-in plugins.http-api— shared HTTP models.runelite-jshell— developer console support.- OOSRS-Plugins — a separate repository containing three installable examples, included by default in the client.
Existing Java package names preserve plugin compatibility. Revision 240 is the initial published baseline. Unverified packet layouts remain disabled; the API does not promise that every possible action is supported.
See what changed in 1.2.0 and the existing API compatibility limits.
Open an issue with your client version and a redacted error log, or send a focused pull request. Build the affected module and describe the behavior you changed. Never include account credentials or private session data. See CONTRIBUTING.md.
See LICENSE, NOTICE, and individual source headers. This repository contains the open-source client and API; the separately downloaded game dependency has its own terms.
Plugins built on the OpenOSRS API can act through a real, moving cursor instead of submitting interactions directly. It is off by default; switch it on under Mouse settings. See the human input guide for the settings, plugin integration, completion handling and current limits.
See the 1.2.0 verification status for the released build and the scope of live mouse checks.