From 33bf19d466414e90285b96918ef36df80f0d30d4 Mon Sep 17 00:00:00 2001 From: therealunull Date: Tue, 15 Dec 2020 01:54:10 -0500 Subject: [PATCH] update README.md --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bec2eadd71..905def402b 100644 --- a/README.md +++ b/README.md @@ -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. - +[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)