Configuration
You can validate that your Kraken Plugins Client installation worked correctly be checking to see that the Kraken logo appears in the sidebar of your client.
If the Kraken icon is not appearing in your sidebar check your normal RuneLite plugins for the plugin called Kraken Plugins. If this plugin is disabled, enable it. You should now see the Kraken icon in your RuneLite sidebar.
Client Options
The Kraken Plugins plugin has its own configuration, opened with the cog icon next to it in RuneLite's plugin list.
General
| Option | Default | What it does |
|---|---|---|
| Skip Side Load | Off | Do not load plugin JARs from ~/.runelite/kraken/sideloaded-plugins. See sideloaded plugins. |
| Skip External Load | Off | Do not load plugins from external repositories. See external plugins. |
| Plugin Tags Display | Show All | Which tags to show in front of plugin names in the Kraken plugin list: [ T ] for trial plugins, [ S ] for sideloaded plugins, and the first letter of the repository name for external plugins. Options: Show All, Show None, Trial Only, External Only, Sideload Only. |
Client Patches
These are all on by default and are what let Kraken plugins run alongside RuneLite. Leave them on unless a Kraken developer asks you to change one while troubleshooting.
| Option | Default | What it does |
|---|---|---|
| Patch Mouse Hook | On | Makes the client treat every click as a normal, physical mouse click. |
| Patch Packet Listener | On | Lets Kraken plugins observe the packets the client sends. Plugins that time overlays off packets need it. |
| Patch Client Callstack | On | Keeps the client's startup fingerprint identical to a normal RuneLite start. |
| Patch Agent | On | Removes the Kraken launcher from the platform information the client reports when you log in. |
⚠️ If the client fails to load it's likely due to a game update. Changing these options may help get the client to load but generally WILL NOT and you'll have to wait for a Kraken update to play with the plugins again.
Overlays
These draw debug information on the game canvas and are meant for plugin developers. They are all off by default: Show NPC's, Show Ground Items, Show Game Objects, Show Players, Show Local Player, and Show Inventory.
Debug Logs prints extra Kraken log lines to RuneLite's client.log. This can give some more insight into what is going wrong when launching the client or using plugins. See accessing logs.
Signing In
When you first launch the client, you will see a "Sign in with Discord" button in the Kraken sidebar. See Client Signup for how the sign in works and what to do if it does not complete.
⚠️ Sign in to the same Discord account in the client that you use to buy plugins. See Account Linking.
Launcher Configuration
When RuneLite opens, it uses a separate launcher program which will grab the latest version of RuneLite and its dependencies before launching the client process. This ensures that RuneLite is able to update regularly behind the scenes and ensures users don't have to constantly re-download the latest client.
Because Kraken is built directly on top of RuneLite it is able to hook into this launcher process so you don't have to constantly update Kraken or its dependencies! Every time RuneLite starts, Kraken downloads the latest Kraken client plugin and API. Before that happens, the Kraken launcher window appears (unless you enable Skip Launcher) with these options:
- RuneLite Mode
- Skip Update Check
- Skip Launcher
- Share Error Logs
- Character
- Proxy
See launcher configuration for more detailed information on each of these features and the command-line flags the launcher accepts.
RuneLite's own launcher settings (memory, hardware acceleration, client arguments) are separate from the Kraken window and are opened as follows.
Windows
To configure the launcher on Windows, press your start key and search for "RuneLite (Configure)" and press enter. This will launch a window where you can configure options for how RuneLite starts. See more information about each of these options here
Mac
Configuring the launcher is a little trickier on macOS. Open up a new "Terminal" window by hitting the Command + Spacebar and searching for "Terminal". Copy and paste the following line to launch the configuration window:
java -jar /Applications/RuneLite.app/Contents/Resources/RuneLite.jar --configure
You should see a new window popup with RuneLite configuration options. See more information about each of these options here
Proxy Configuration
The Kraken Launcher supports SOCKS5 proxies. For more information on setting up proxies, view our proxy documentation.
Plugin Configuration
Kraken Plugins work just like normal RuneLite plugins you can configure them by clicking the "Cog" icon and tweaking various settings for each plugin.