To get going, currently you will need to publish the injector to mavenLocal: (only need to run when updating injector)
openosrs-injector:
clean build publishToMavenLocal

Then you can run the client in gradle from the root project using:
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.

Discord

Project Layout

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-plugin - Tool for implementing our modifications to the 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

Building

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

Install from Pre-built Binaries

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

License

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

Contribute and Develop

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

Supported By

OpenOSRS uses profiling tools provided by YourKit

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

Wiki

Check out the OpenOSRS wiki to learn more