Configuration

To apply the plugin, simply add the following to your Gradle build script (build.gradle.kts):

plugins {
    id("com.runemate") version "1.5.0"
}

runemate {
    devMode = true
    autoLogin = true
}

Be sure to check that you always have the latest version of the plugin from the Gradle plugin portal.

The plugin is configured by changing properties in the runemate block. The full list of configuration options are below:

Properties

OptionDescriptionDefault

autoLogin

Tells the client to attempt automatic login

false

devMode

Tells the client to launch in developer mode

true

debug

Tells the client to enable debug logging

false

apiVersion

Tells Gradle which version of runemate-game-api to fetch from Maven

+ (latest)

pathfinderVersion

Tells Gradle which version of runemate-pathfinder-api to fetch from Maven

+ (latest)

clientVersion

Tells Gradle which version of runemate-client to fetch from Maven

+ (latest)

botDirectories

Tells the client which directories to scan for bots

$projectDir/build/libs (project build directory)

allowExternalDependencies

Tells Gradle to allow dependency resolution for external dependencies

false

excludeFromSubmission

Tells Gradle to exclude the module this extension is registered to from store submission

false

submissionToken

The token used to authenticate when publishing your products (see Publishing to Store)

The first non-null value in order: this property value, project property runemateSubmissionToken, system property runemateSubmissionToken, environment variable RUNEMATE_SUBMISSION_TOKEN

Getting the correct RuneMate version

The Gradle plugin will automatically search for the latest runemate-client and runemate-game-api versions, but caching can mean that after an update it could take a long time for Gradle to recognise the new versions. There are two ways to work around this temporarily:

#1 Refresh Gradle Dependencies
  • Open the Gradle tool window in IntelliJ IDEA

  • Right-click on the project name

  • Select "Refresh Gradle Dependencies"

#2 Define the versions manually

In your Gradle build script (build.gradle.kts), you can declare the RuneMate library versions Gradle will use in the runemate configuration block:

runemate {
    // ... other configuration
    apiVersion = "1.2.3"
    clientVersion = "4.3.2.1"
}

Launching the client

The plugin adds the runClient task to your Gradle project, this will launch the client using the configuration as described above. You can run this task using the Gradle tool window in IntelliJ IDEA or by running the following command:

./gradlew runClient

Last updated