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.

🛠️ Getting Started

1. Clone the repository

   • File → New → Project from Version Control in IntelliJ, then paste https://github.com/OpenRune/OpenRune-Server.git.
   • OpenRune Servernatively, 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 Rsc plugin in root of the project OpenRune IntelliJ Tools-1.0.zip for better entity reference tooling.

   • You may need to point the settings file openRune-intelliJ-tools.toml like so

   

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_238.ws
    varp_count: 15000
    revision: 238
    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.

📦 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