ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
therealunull
2020-12-15 01:54:10 -05:00
parent 211bae7797
commit 33bf19d466
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -2,12 +2,25 @@
# OpenOSRS
# OpenOSRS injected RuneLite
[![Build Status](https://github.com/open-osrs/runelite/workflows/OpenOSRS%20-%20CI%20(push)/badge.svg)](https://github.com/open-osrs/runelite/actions?query=workflow%3A%22OpenOSRS+-+CI+%28push%29%22)
[![HitCount](http://hits.dwyl.io/open-osrs/runelite.svg)](http://hits.dwyl.io/open-osrs/runelite)
[OpenOSRS](https://openosrs.com) 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)
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
[![Discord](https://img.shields.io/discord/373382904769675265.svg)](https://discord.gg/openosrs)