OpenOSRS is a fully open-source client with no restrictions. We are not affiliated with Jagex or RuneLite.

This is a special branch that uses the upstream client (RuneLite) with the OpenOSRS injector. (bundled)

From the root module, run the following gradle tasks:
clean build run

This branch is still in bringup but most functionality works as intended.
This branch uses upstreams PlayerManager/OverlayManager etc so keep that in mind if porting a plugin.

Contributions are welcome, but there should be no changes made to runelite-client unless necessary/minor. Mould the api around the client.

• First clone this repository

• Open it in Intellij (Or what ever IDE you have)

  • Make sure to use JDK 11

• Wait for it to fully load

• You should see Gradle button on your right side by default open that tab

• Expand OpenOSRS -> Tasks -> openosrs -> (Right click) on run -> and choose modify run configuration

• Inside Run textarea copy and paste: run --args="--developer-mode --debug --jav_config "https://raw.githubusercontent.com/AlterRSPS/Runelite/master/jav_config.ws"" -x checkStyleMain -x checkStyleTest -x test

• Apply and Done now couple times press on that run task in gradle tab

• When the client fully loads you should see: You have to change the Key(Modulus) to RSPS that you wish to connect. After it loads and you changed the Key just re-enable the Private Server plugin.

• Click ok and go to plugins menu search for Private Server click the settings icon enter your RSA Key that you received from your server when doing install process.

  • In case you lost the RSA Key: Just do install task in your server to gain new RSA Key.

• Disable and Enable the private server plugin and done you can login.

• Side note: make sure your server is running. Otherwise, the clients screen will be black.

• cache - Libraries used for reading/writing cache files, as well as the data in it
• deobfuscator - Can decompile and cleanup gamepacks as well as map updates to newer revs
• http-api - API for runelite and OpenOSRS
• injector - Bytecode weaver that allows us to add code to the obfuscated gamepack
• runelite-api - RuneLite API, interfaces for accessing the client
• runelite-mixins - Classes containing the Objects to be injected using the injector-plugin
• runescape-api - Mappings correspond to these interfaces, runelite-api is a subset of this
• runelite-client - Game client with plugins
• wiki-scraper - Scrapes the runescape wiki https://oldschool.runescape.wiki for the latest npc data

We have migrated the project to Gradle. Information on how to setup and build the project can be found at https://github.com/open-osrs/runelite/wiki/Building-with-IntelliJ-IDEA

Installers for Windows, Mac and Linux can be found at https://github.com/open-osrs/launcher/releases

OpenOSRS is licensed under the BSD 2-clause license. See the license header in the respective file to be sure.

We've set up a separate document for our contribution guidelines.

OpenOSRS uses profiling tools provided by YourKit

Thanks JetBrains for providing our developers with IntelliJ IDEA Ultimate Edition.

Check out the OpenOSRS wiki to learn more