OpenOSRS

OpenOSRS — Free Download. Extensible client

OpenOSRS is an extensible desktop client for Old School RuneScape that loads plugins from GitHub repositories, provides entity queries, inventory and equipment inspection, event and overlay handling, widget and dialogue reading, movement and world state access, game service helpers, and external repository installation. The client supports profiles, launcher-based updates, cached downloads, and building from source with Java 11 or newer. A separate example repository includes three small plugins covering game events, NPC overlays and inventory changes.

★★★★★
5.0(1 ratings)
Download OpenOSRS (Official links)
File size: 40 MB
The latest version of OpenOSRS is: 1.0.3
Operating system: Windows, Mac OS, Linux
Languages: English
Developer: OOSRS
Price: $0.00 USD (Open Source (BSD-2-Clause))
  • Entity Queries. The entity query function finds NPCs, players, objects, and ground items using readable filters. It scans the game world for matching entities and returns collections that plugins can process. This supports targeting, tracking, and overlay generation without manual memory scanning.
  • Inventory and Equipment Inspection. This function inspects items, quantities, slots, and equipment state. It counts specific item IDs, checks whether the inventory is full, and reports equipped gear. Plugins use it for banking logic, combat checks, and resource management.
  • Events and Overlays. The event and overlay function reacts to game changes and presents information on screen. It subscribes to game events, triggers callbacks, and draws graphical elements such as timers, highlights, and labels over the game view.
  • Widgets and Dialogue. This function reads interfaces and uses available actions through shared services. It detects open widgets, reads dialogue text, and activates buttons or menu options. Plugins rely on it for automated interface navigation and state detection.
  • Movement and World State. The movement and world state function works with paths, tiles, camera state, scenes, and maps. It reports the player position, nearby tiles, camera angle, and loaded scene data. This supports pathfinding, minimap rendering, and location-aware plugins.
  • Game Services. The game services function provides focused helpers for skills, combat, prayer, magic, banking, and more. Each service exposes methods for common tasks such as checking skill levels, activating prayers, casting spells, and opening bank interfaces.
  • External Repositories. The external repository function installs independently built plugin JARs through the client repository feature. It fetches plugin manifests from GitHub, verifies downloads, and loads third-party plugins without modifying the core client.
  • Profiles Sidebar. The profiles sidebar function adds Jagex accounts, saves characters, and selects one at the login screen. It stores multiple account configurations and switches between them, reducing manual login steps.
  • Launcher Updates. The launcher update function checks for client and launcher updates, verifies downloads, and keeps cached files. It separates release channels and preserves existing cached files when a download fails.
  • Build from Source. The build function compiles the client from source using Gradle. It fetches a pinned game dependency, verifies its SHA-256 hash, and produces an executable client JAR without private maintainer tools.
  • Developer Console. The developer console function supports runtime inspection through a JShell-based environment. It allows developers to evaluate expressions, query the API, and test plugin behavior during development.
  • API Facade. The API facade function exposes services through net.openosrs.api.OpenOSRS. It provides a single entry point for queries, interactions, and game helpers, keeping plugin code consistent across modules.

OpenOSRS was created as an independently maintained community fork that builds on the OpenOSRS and RuneLite projects. The repository is maintained by the OOSRS organization, and development is conducted through public issues and pull requests. The initial published baseline is revision 240, and release notes document supported baselines and compatibility limits. The program is written in Java and requires a Java 11 JDK for building from source. The project layout separates the API facade, game and plugin compatibility interfaces, the desktop client, shared HTTP models and a developer console module. Existing Java package names preserve plugin compatibility, while unverified packet layouts remain disabled. The license files and source headers define the terms for the client and API, and the separately downloaded game dependency carries its own terms.

Alternatives to OpenOSRS: