consts-osrs

RuneLite plugins for Old School RuneScape ( OSRS ), by const. One Gradle build, one plugin per folder.

Plugin	What it does
consts-EXP	The all-in-one XP helper. Today that's OSRS AFK alerts with presets for chinning, crabbing, mining, woodcutting, fishing and salvaging, Forestry events included: beeps, screen flashes and a status panel, plus XP per hour, a tick pendulum for tick-perfect clicks, a timer on each tree, from Tree Despawn Timer, whether the Stealing Artefacts guards are lured, and GOTR Autopilot for Guardians of the Rift.
consts-Destination	Lights up the tile and anything you hover that you can act on, keeps what you clicked lit until you're done, lets a left-click go past loot and campfires, and draws your tile packs, sets of marked tiles you make or paste in. Folds in RuneLite's Interact Highlight and Tile Packs.
consts-Leaderboard	Any player's skills from the hiscores in a sidebar panel: right-click and Lookup, click a friend, or one button for your own. Levels stop at 99: a 99 is yellow, the lowest skill red. Cut down from RuneLite's HiScore.
consts-Models	Export any model in the game, or the area around you: right-click Export Model, turn it in a viewer, play and step a player's or NPC's animations, take out the pieces you don't want, and save it as OBJ, PLY or GLB with its animations, for Blender and other 3D software. Built on the Plugin Hub's Model Exporter.
consts-World	A world switcher that opens on your hot list: star the worlds you hop between once, then hop with a click. Search and sort either tab, the hot list or all worlds, by activity, number or region. Starts you back on the world you were last on. Cut down from RuneLite's World Hopper.

More at constdecimalserrno.dev/consts-osrs.

Run it

The plugins aren't on the Plugin Hub yet, so you run RuneLite from this repo with every plugin loaded.

Prerequisites

• JDK 17+ to run Gradle
• JDK 11 for the RuneLite client (Temurin 11 works)
• RuneLite installed from runelite.net

run.sh defaults to the Homebrew OpenJDK and Temurin 11 paths on macOS. Anywhere else, point it at your JDKs:

export JAVA_HOME=/path/to/jdk-17          # runs Gradle
export RUNELITE_JAVA_HOME=/path/to/jdk-11 # runs the client

Jagex accounts (one time)

A client started from source can't log in through the Jagex Launcher by itself. Let the launcher hand it your session once:

1. Open RuneLite's configure mode (RuneLite --configure; on macOS /Applications/RuneLite.app/Contents/MacOS/RuneLite --configure).
2. Add the client argument --insecure-write-credentials and save.
3. Launch RuneLite from the Jagex Launcher and log in once.

RuneLite writes ~/.runelite/credentials.properties, and the client started from source logs in with it. Treat that file like a password.

Launch

./run.sh all        # tests, compile, launch RuneLite with every plugin
./run.sh runClient  # launch only
./run.sh test       # tests only

The plugin shows up in RuneLite's plugin list. Its settings live under the wrench.

Releases

Play kit

For a machine that plays without building: ./gradlew playKit writes build/play-kit/, with consts-osrs.jar, RuneLite and every plugin in one jar, and play.sh, which starts it on Java 11 (Temurin 11's macOS path, or RUNELITE_JAVA_HOME). Copy the folder over and run play.sh; the Jagex account step above is needed there too. The jar holds the RuneLite of the day it was built, so after a RuneLite update build it again with ./gradlew playKit --refresh-dependencies.

Each release attaches a compiled plugin jar. Plugins are versioned and tagged on their own: consts-destination-v1.0.0, and consts-EXP from consts-exp-v2.0.0 on. As consts-AFK it was tagged consts-afk-v1.8.0 to consts-afk-v1.14.0, and plain v1.0.0 to v1.7.0 before that. Build them yourself with ./gradlew jar; they land in <plugin>/build/libs/.

Project structure

consts-osrs/
├── build.gradle                  # Shared config: Java 11, RuneLite, tests
├── settings.gradle               # One include per plugin
├── run.sh                        # Build and launch
├── scripts/publish-hub-branch.sh # Cut a plugin's Plugin Hub branch
├── scripts/play.sh               # Starts the play kit's jar
├── src/test/java/com/osrs/
│   └── PluginLauncher.java       # Loads every plugin into one RuneLite client
├── consts-exp/
│   ├── runelite-plugin.properties  # Plugin Hub metadata
│   ├── icon.png                    # Plugin Hub icon, 48×72
│   └── src/main/java/com/constsexp/...
├── consts-destination/
│   ├── runelite-plugin.properties
│   ├── icon.png
│   └── src/main/java/com/constsdestination/...
├── consts-leaderboard/
│   ├── runelite-plugin.properties
│   ├── icon.png
│   └── src/main/java/com/constsleaderboard/...
├── consts-models/
│   ├── runelite-plugin.properties
│   ├── icon.png
│   └── src/main/java/com/constsmodels/...
└── consts-world/
    ├── runelite-plugin.properties
    ├── icon.png
    └── src/main/java/com/constsworld/...

Each plugin is a Gradle subproject with its own version. Shared settings live in the root build.gradle; a plugin's own build.gradle holds its version and any overrides.

Plugin Hub

The Plugin Hub builds a plugin only from the root of a repo, so each plugin gets its own branch, plugin-hub/<plugin>, holding just its folder. scripts/publish-hub-branch.sh consts-exp cuts it from main with git subtree split, pushes it, and prints the repository= and commit= lines for the plugin's manifest in runelite/plugin-hub. The Hub replaces the plugin's build.gradle (build=standard), so a plugin may only depend on RuneLite itself.

Adding a plugin

1. Create new-plugin/src/main/java/com/newplugin/ and new-plugin/src/test/java/com/newplugin/.
2. Add new-plugin/build.gradle (a comment is enough).
3. Add include 'new-plugin' to settings.gradle and implementation project(':new-plugin') to the root build.gradle dependencies.
4. Write NewPlugin.java (extends Plugin, has @PluginDescriptor) and NewPluginConfig.java (extends Config, has @ConfigGroup).
5. Add NewPlugin.class to ExternalPluginManager.loadBuiltin(...) in PluginLauncher.java, and give the plugin its own new-plugin/runelite-plugin.properties (copy consts-exp's).
6. ./run.sh all.

License

MIT. Each plugin folder carries its own copy, because the Plugin Hub builds a plugin from its folder alone. Code ported from RuneLite plugins keeps its BSD 2-Clause license: NPC Aggression Timer by Woox in consts-EXP (NOTICE), Interact Highlight by Adam in consts-Destination (NOTICE), the Configuration panel by Adam in both, as their sidebar settings, HiScore by Adam, Psikoi and Bram91 in consts-Leaderboard (NOTICE) and World Hopper by Adam, Lotto, gregg1494 and Psikoi, with a part of Default World by Tomas Slusny, in consts-World (NOTICE). So do the Plugin Hub's Tree Despawn Timer by Jason O'Neill and GOTR Autopilot by FabulousOtter, folded into consts-EXP (same NOTICE), its Tile Packs by TrevorMDev, folded into consts-Destination (same NOTICE), and its Model Exporter by Bram91, with RuneLite's JagexColor by Abex, in consts-Models (NOTICE). The Plugin Hub's Stealing Artefacts by Christopher Bitler, whose guard check is folded into consts-EXP, keeps its MIT license (same NOTICE).

Not affiliated with Jagex or RuneLite. Old School RuneScape is a trademark of Jagex Ltd.