OpenRune Server is a modular fork of RSMod/Alter that powers an OSRS-compatible server with a plug-and-play plugin ecosystem focused on extensibility and ease of use.

🤔 What is OpenRune Server?

OpenRune Server builds on the foundation laid by RSMod to deliver a flexible, developer-friendly OSRS game server. Its modular architecture lets you ship new gameplay features as standalone plugins without touching core engine code. Server owners with little to no programming experience can rely on contributors to drop prebuilt plugins into the content module and have them load automatically at runtime.

🚀 Why Choose OpenRune Server?

🔧 Modular by design

OpenRune Server loads plugins dynamically, making it simple to extend gameplay, content, or systems while keeping the base server clean.

👥 Community-driven

Active maintainers review contributions, publish roadmap updates, and support users through Discord and Trello.

📏 OSRS-compatible

OpenRune Server adheres to OSRS protocols, giving you the freedom to connect any compliant client and customize server-side behavior.

📊 Content progress

Skills 20/23 · Bosses 25/179 · Raids 0/4 · Minigames 2/46

Full breakdown in PROGRESS.md, including every content module and the bosses that already have drop tables and only need the encounter writing.

📚 Wiki

Browse the OpenRune Server wiki at openrune.github.io — an interactive graph of the codebase beside a live Markdown reader, covering architecture, cache, gameplay, interfaces, networking, operations, persistence, plugins and testing.

The pages are generated by OpenWiki and committed under openwiki/, so they version alongside the code and can be read straight from the repo — start at openwiki/quickstart.md. The published site rebuilds from main.

🛠️ Getting Started

1. Clone the repository

   • File → New → Project from Version Control in IntelliJ, then paste https://github.com/OpenRune/OpenRune-Server.git.
   • Alternatively, clone via Git CLI and open the project manually.

2. Install dependencies

   • Ensure you have IntelliJ IDEA.

   • Set the project SDK to Java 21: File → Project Structure → SDK. (The :tools:osrs-mcp module is built with Java 17 via Gradle’s JVM toolchain; other modules target Java 21.)

   • Recommended: install the OpenRune IntelliJ Tools plugin for better entity reference tooling. The plugin zip, OpenRune IntelliJ Tools-1.1.zip, sits in the root of the project.

     • File → Settings → Plugins → ⚙️ (Settings cog) → Install Plugin from Disk..., choose OpenRune IntelliJ Tools-1.1.zip, then restart the IDE when prompted.

   • Point the plugin at the settings file

     • File → Settings → OpenRune Settings, choose openRune-intelliJ-tools.toml from the project root.
   

3. Gradle bootstrap

   • Open the Gradle tool window.
   • Run OpenRune Server → Tasks → installation → install.
   • When the task completes, run OpenRune Server → Tasks → application → run.

4. Verify startup

   • A successful boot prints OpenRune Server Successfully initialized in the terminal.
   • If you only see OpenRune Server Loaded up in x ms. you likely skipped a step.

Screenshots showcasing each step are available in the repo under Resources/main/docs/resources/ReadMe_OpenRune Server/.

🎮 Client Setup

Tip

Use RSProx to connect; it is actively maintained by trusted developers and supports the required OSRS protocols.

For Windows:

1. Press ⊞ + R and enter %USERPROFILE%.
2. Locate (or create) the .rsprox directory.
3. Create proxy-targets.yaml with:

config:
  - id: 1
    name: OpenRune Server
    jav_config_url: https://client.blurite.io/jav_local_241.ws
    varp_count: 15000
    revision: 241
    modulus: YOUR_MODULUS_KEY_HERE

Find the modulus in the project root .data/client.key, copy it exactly, and replace YOUR_MODULUS_KEY_HERE. If .rsprox does not exist, launching RSProx once will create it. Note: RSprox for Private Servers only works currently on Windows and Linux, NOT MacOS!

Warning

And stay away from client's like Devious, as they have been caught adding Account Stealer into their client.

🤖 AI testing (MCP)

The OpenRune-Developer-Tools client plugin runs a local MCP server (http://127.0.0.1:7780/mcp) so AI agents like Claude can test server content in a live client: walk NPC dialogue trees, screenshot and diff interfaces, read varbits/clientscript history, interact with NPCs/objects/items and wait on game conditions. A live dashboard at http://127.0.0.1:7780/ shows every call the AI makes, with results and screenshots. Setup, example prompts and verification flows are documented in AGENTS.md.

📦 Release builds

CI can produce a self-contained openrune-server-release.zip with server.jar, game.yml, and compiled .data/. Pushes to production publish automatically; other branches can be built manually from Actions → Release Server.

See .github/docs/RELEASE_CI.md for what the workflow does, how to run it manually, and how to build from production vs main/feature branches.

🗺️ Project Planning

• Public roadmap and task board: OpenRune Server Trello.
• Trello write access and contributor listing are reserved for active maintainers—contact Chris via Discord with a short summary of your work if you need access.

💬 Bug Reports & Support

• Open an issue on GitHub with reproduction details.
• Reach the team directly in the Discord server.

🙏 Acknowledgments

• Cache management powered by OpenRune-FileStore.
• Original Base RsMod2.

💙 Contributors