JGoodier/runelite

Open source Old School RuneScape client https://runelite.net

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.jgoodier:runelite:runelite-parent-1.5.12'
	}
	dependencies {
		implementation("com.github.jgoodier:runelite:runelite-parent-1.5.12")
	}
	<dependency>
	    <groupId>com.github.jgoodier</groupId>
	    <artifactId>runelite</artifactId>
	    <version>runelite-parent-1.5.12</version>
	</dependency>

                            
    libraryDependencies += "com.github.jgoodier" % "runelite" % "runelite-parent-1.5.12"
        
        

                            
    :dependencies [[com.github.jgoodier/runelite "runelite-parent-1.5.12"]]

Readme

runelite Travis Discord

RuneLite is a free, open source OldSchool RuneScape client.

If you have any questions, please join our IRC channel on irc.rizon.net #runelite or alternatively our Discord server.

Project Layout

  • cache - Libraries used for reading/writing cache files, as well as the data in it
  • http-api - API for api.runelite.net
  • http-service - Service for api.runelite.net
  • runelite-api - RuneLite API, interfaces for accessing the client
  • runelite-mixins - Mixins which are injected into the injected client's classes
  • runescape-api - Mappings correspond to these interfaces, runelite-api is a subset of this
  • runelite-client - Game client with plugins

Usage

Open the project in your IDE as a Maven project, build the root module and then run the RuneLite class in runelite-client.
For more information visit the RuneLite Wiki.

License

RuneLite 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.