Getting Started

From purchase to running your first plugin in under 5 minutes

Don't have a plugin yet? Browse plugins →

Before You Start

RuneLite

The official, unmodified RuneLite client. Download it from runelite.net. No custom fork, no modified launcher — just the RuneLite you already use.

Curious what the plugin actually installs? Read the Trust & Transparency page →

Your license key

Shown on the confirmation page as soon as your payment confirms, and emailed to the address you entered at checkout. Check spam if you can't find it.

The Pluginscape installer

A small download, also linked from the confirmation page, in a Windows and a macOS build. It does the whole setup for you — you never place files by hand or touch RuneLite's settings.

Java

RuneLite handles Java for you — no separate install needed.

Installation

Want to know exactly what you're installing? See our Trust page →

Step 1 — Copy your license key

Your license key appears on the confirmation page as soon as your payment confirms — hit Copy. It's also emailed to the address you entered at checkout. One key covers every plugin on your order.

Step 2 — Download the installer

The same confirmation page has a Download Installer button. Grab the Windows or macOS build and unzip it. Keep pluginscape-agent.jar in the same folder as the install script — the installer looks for it right next to itself.

Step 3 — Run the installer

It asks for your license key, then does the rest on its own:

  • Downloads your plugin JAR to ~/.runelite/sideloaded-plugins/
  • Copies pluginscape-agent.jar into ~/.runelite/
  • Points JAVA_TOOL_OPTIONS at that agent, so RuneLite loads the sideload folder

Step 4 — Fully quit and relaunch RuneLite

This step is not optional. JAVA_TOOL_OPTIONS is only read when a Java process starts, so a RuneLite that was already running will not pick up the agent. Quit it completely — Cmd+Q on macOS, not just closing the window — then start it again.

Step 5 — Find your plugins

There's no activation step. Your key is read straight from the JAR filename, so the plugins you own show up in RuneLite's normal plugin list and sidebar the moment the client starts. The Pluginscape panel in the sidebar shows your version and update status.

Updates

The plugin checks your license when RuneLite starts and every 15 minutes after that. The same check tells it whether a newer build exists.

When there is one, it downloads in the background and is verified against a SHA-256 hash — a file that doesn't match is deleted rather than installed. The Pluginscape panel in the sidebar shows your installed version, the latest version, release notes, and says Restart RuneLite to apply once the new build is ready. On Windows the running JAR is locked, so the update is staged and swapped in on your next launch.

You never re-download a JAR by hand and you never re-run the installer for a normal update. Buying another plugin works the same way — it unlocks on the next license check.

If our server is unreachable, your plugins keep working with the entitlements they already had. An outage on our end will not lock you out of software you bought.

Updates are free for life. No re-purchase, no subscription.

Troubleshooting

Plugins don't show up in RuneLite

Nine times out of ten, RuneLite was already running when you installed. Quit it completely (Cmd+Q on macOS) and relaunch — a window close is not enough. To confirm the agent is loading, look for a [Pluginscape] Agent loaded line in RuneLite's logs. If that line is missing, the installer didn't wire up JAVA_TOOL_OPTIONS — run it again.

"Invalid or inactive license key" while installing

The installer asks our server for your plugin JAR and was turned away. Re-copy the key from your confirmation page or email — the Copy button avoids stray spaces and missed characters. If it still fails, get in touch and we'll check the order.

"HWID limit reached"

Your license covers two machines. The first two you run it on take the slots; a third gets this message rather than failing silently. Docks, VPNs, and new network adapters don't burn a slot — the fingerprint doesn't use MAC addresses. Changed hardware or reinstalled your OS? for a reset.

Windows won't run the installer script

PowerShell blocks scripts downloaded from the internet by default. Right-click install-pluginscape.ps1, choose Properties, and tick Unblock — then run it again. No admin rights are needed at any point; the installer only writes to your own user account.

Plugin stopped working after a game update

OSRS game updates can change internal IDs that plugins rely on. We push compatibility patches as fast as possible — usually within 24–48 hours, and they arrive automatically. Don't panic if a plugin errors on update day.

Can I use Pluginscape alongside Plugin Hub plugins?

Yes. Pluginscape plugins coexist with any Plugin Hub or other sideloaded plugins, and the uninstaller only removes its own files — anything else in your sideload folder is left alone.

Can I run multiple Pluginscape plugins at once?

Yes. Everything you own ships in that one JAR and unlocks against your license, so there's nothing extra to install when you buy another plugin — it appears after the next license check. Run as many as you like in the same RuneLite session.

Something else is wrong and I need to send you details

Open the Pluginscape plugin's config, go to Telemetry, and tick Export Support Bundle — it writes a session dump you can attach to a ticket, then unticks itself. Open Logs Folder in the same section opens the folder holding client.log.

Platform Support

OSSupportedNotes
WindowsYesWindows 10/11. Primary test platform.
macOSYesIntel and Apple Silicon via RuneLite.
LinuxYesAny distro that runs RuneLite.

Need help?

Browse our plugin catalog, or get in touch if you get stuck — we answer setup questions directly.

Your Cart

Your cart is empty.