Skip to content

Scheie/vmine-skiller-plugin

Repository files navigation

Volcanic Skiller

A RuneLite plugin for the Volcanic Mine minigame, aimed at skilling accounts.

Features

  • Reward-point tracking — keeps a running total of your Volcanic Mine reward points, shown in an on-screen overlay and a sidebar panel so it is visible everywhere, including outside the minigame instance.
  • Game-start notification — fires a RuneLite notification the moment a Volcanic Mine game begins, so you can do something else while in the lobby.

Configuration

  • Game start notification — notify when a game begins. Use the settings wheel to turn it on/off and configure delivery (sound, tray, request focus).
  • Show reward points overlay — toggle the on-screen overlay.

How reward-point tracking works

The spendable balance stored with Petrified Pete lives in VarPlayer 261 (the reward shop renders it via the game's [proc,fossil_volcanic_shop_points] script). That varp is only transmitted to the client while the reward shop is open, so the plugin combines two signals to keep the total live and correct:

  1. Earning — during a game the per-game points (varbit 5934) are tracked. When a game completes, Volcanic Mine grants a lump of Mining experience as you leave; that Mining XP gain is the reliable "game finished" signal, so the points earned are added to your total then.
  2. Truth / spending — while Petrified Pete's Ore Shop (interface group 612) is open, the total is synced every tick to the balance shown on its "Points:" line (FossilVolcanicShop.POINTS). That line is the authoritative displayed value for every amount — including 0 after spending everything — so it captures spending, which the earn-side tracking cannot see, and corrects any drift. Because purchases happen with the shop open, spending is reflected live.

The total is persisted per RuneLite profile (config key rewardPoints) so it is shown immediately on startup. The balance is not readable at login, so between shop visits the displayed total is the last synced value plus points banked since — open the shop once to reconcile it exactly.

The overlay/panel also show points this game — the running score for the current game (varbit 5934), which resets each game and is separate from your banked total. Game state comes from varbit 5941 (0 = not in the minigame, 1 = lobby, 2 = in game). These minigame varbit/varp ids are not in the RuneLite API, so they are referenced directly in the plugin.

Building and running from source

RuneLite targets Java 11, and the Plugin Hub builds with it. This repo is verified to build and pass checkstyle with Amazon Corretto 11. Newer JDKs (e.g. 25) are not supported by the template's Gradle/Lombok versions.

# Point JAVA_HOME at a JDK 11 install, e.g.:
export JAVA_HOME="$(/usr/libexec/java_home -v 11)"

# Build (compile + checkstyle + tests)
./gradlew build

# Launch RuneLite in developer mode with this plugin loaded
./gradlew run

In the running client, enable Volcanic Skiller in the plugin list. The overlay appears on the game screen; the sidebar volcano icon opens the panel.

Project layout

Path Purpose
src/main/java/com/volcanicskiller/VolcanicSkillerPlugin.java Plugin entry point: points tracking, game-start notification
src/main/java/com/volcanicskiller/VolcanicSkillerConfig.java Config (notification, overlay toggle)
src/main/java/com/volcanicskiller/VolcanicSkillerOverlay.java On-screen overlay showing the reward-point total
src/main/java/com/volcanicskiller/VolcanicSkillerPanel.java Sidebar panel showing the reward-point total
src/test/java/com/volcanicskiller/VolcanicSkillerPluginTest.java Dev launcher used by the run task
runelite-plugin.properties Plugin Hub metadata
icon.png Plugin Hub listing icon (128×128)

About

A skiller pure friendly plugin for the Volcanic mine minigame in OSRS

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages