Skip to content

Latest commit

 

History

History
164 lines (112 loc) · 7.35 KB

README.md

File metadata and controls

164 lines (112 loc) · 7.35 KB

Contributors Forks Stargazers Issues MIT License


Logo

Kraken Launcher

A RuneLite launcher which side-loads the Kraken essential plugins.

This project is a modified fork of the RuneLite launcher.

Loads the latest version of the Kraken Client from S3. This allows updates to be made to the Kraken client independently of user downloads. With this tool users no longer need to constantly download the newest version of the Kraken Client to play the game. Instead, they can download this launcher JAR once, and it will automatically pull the latest Kraken client from S3 for users.

This should be the primary way users launch the game if they intend to use Kraken plugins.

Currently, all plugins for the client are released for free at our discord here. Some features this client offers are:

  • Discord authentication and sign up / sign in
  • Auto plugin loading (and automatic plugin & client updates)
  • Jagex account compatibility
  • Native Jagex Launcher Compatibility
  • RuneLite mode (Run the client as normal RuneLite without any Kraken plugins)
  • Native RuneLite Client (no injection or client modification)

Although the Kraken client is safe and doesn't modify RuneLite in any way the plugins are unofficial. We are not responsible for any bans you may incur for using this client. For more information about the Kraken Client see: Kraken Client.

QuickStart

To get started with the launcher and get yourself some plugins join our discord here and create a new ticket! You can view our currently available plugins below.

Installation

Perform the following to install:

  • On Windows go to C:\Users\<YOUR_NAME>\AppData\Local\RuneLite
  • Rename RuneLite.jar to RuneLite-backup.jar This is the official version of RuneLite if you every want to swap back.
  • Go to our releases page and download the latest version of the launcher jar file. It will be called kraken-launcher-<version>.jar.
  • Move the downloaded kraken-launcher-<version>.jar to C:\Users\<YOUR_NAME>\AppData\Local\RuneLite
  • Rename kraken-launcher-<version>.jar to RuneLite.jar
  • Run with RuneLite.exe or via jagex launcher (see Jagex launcher details below)

Jagex Launcher & Jagex Accounts

The Kraken Launcher is compatible with the Jagex accounts as well as the Jagex launcher. In order to use the Kraken Launcher with Jagex accounts follow this guide:

  • For Windows, run RuneLite (configure) from the start menu. Otherwise, pass --configure to the launcher (i.e. /Applications/RuneLite.app/Contents/MacOS/RuneLite --configure on Mac).
  • In the Client arguments input box add --insecure-write-credentials
  • Click Save
  • Launch RuneLite normally via the Jagex launcher. RuneLite will write your launcher credentials to .runelite/credentials.properties.
  • On your next launch it will use the saved credentials allowing you to use your Jagex account with Kraken plugins.

If you want to use a non-jagex account with Kraken you can delete the credentials.properties file to return your Kraken Client back to normal. If for any reason you need to invalidate the credentials, you can use the "End sessions" button under account settings on runescape.com.

RuneLite Mode

If you would like to run RuneLite like normal without any Kraken plugins loading:

  • Click the windows start menu
  • Type "RuneLite (Configure)" and hit enter
  • In the dialogue box click the "RuneLite mode" checkbox
  • Click Save

Your next client run will not load any Kraken plugins and leave RuneLite untouched.

Current Plugins

Currently, we have the following plugins enabled on the client:

Plugin Name Plugin Description Version
Alchemical Hydra Tracks your prayers, special attacks and when to switch for Hydra. 1.0.2
Cerberus Tracks ghosts, Cerberus prayer rotations, and more. 1.0.0
Effect Timers Tracks freeze, teleblock, and other timers! 1.0.0
Chambers of Xeric Tracks Olm rotations, specials, tick counters, and various boss helpers for CoX. 1.0.4

Getting Started

To get started with development on the kraken launcher, clone this repository with:

git clone https://github.com/cbartram/kraken-launcher.git

You can build and run the jar with:

mvn clean package

java -jar ./target/RuneLite.jar

If you would like to run in developer mode to load Kraken plugins from the /dev prefix in S3 pass:

java -Ddeveloper-mode=true -jar ./target/RuneLite.jar

Prerequisites

Install gradle in order to build and run this program:

Running the tests

Run tests with:

mvn clean test

Deployment

Deployment for this is handled through Circle CI. It builds the JAR file and creates a GitHub release for the newest version of the launcher.

Built With

  • Java - Programming Language Used
  • Gradle - Build Tool

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details

Acknowledgments

  • RuneLite for making a great software! The SplashScreen, and most of this codebase was taken from RuneLite!