https://github.com/cbartram/kraken-example-plugin
An example of a Kraken Plugin which utilizes RuneLite and the Kraken API to automate simple tasks.
https://github.com/cbartram/kraken-example-plugin
Last synced: 5 months ago
JSON representation
An example of a Kraken Plugin which utilizes RuneLite and the Kraken API to automate simple tasks.
- Host: GitHub
- URL: https://github.com/cbartram/kraken-example-plugin
- Owner: cbartram
- License: gpl-3.0
- Created: 2025-08-18T19:36:58.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2026-01-23T20:33:33.000Z (5 months ago)
- Last Synced: 2026-01-24T05:29:29.290Z (5 months ago)
- Language: Java
- Size: 1.01 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kraken Example Plugins
An set of example automation plugins utilizing the Kraken API
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
# Kraken Example Plugins
This repository contains examples for writing automation plugins using the [Kraken API](https://github.com/cbartram/kraken-api.git).
The Kraken API extends the RuneLite API with the ability to interact with various game entities, including:
- Widgets (Prayers, Spells, Interfaces, etc...)
- NPC's
- Players
- Ground Items
- Game Objects
- Equipment
- World Hopping
- Container Items (Inventory, Bank, etc...)
- and more!
The Kraken API also ships with several handy features for developing automation plugins (scripts) right on top of RuneLite
like `TaskChain`'s, pathfinding, advanced mouse movement, abstractions for writing scripts, and network packet classes.
This repository contains several examples of fully functioning automation scripts showcasing the API's capabilities.
### Plugin & Script Requirements
You can read more about the individual plugins, their features, and their requirements
in their respective README's linked below.
- [Mining Plugin](docs/MINING.md)
- [Woodcutting Plugin](docs/WOODCUTTING.md)
- [Fishing Plugin](docs/FISHING.md)
- [Jewelry Plugin](docs/JEWELRY.md)
- [Firemaking Plugin](docs/FIREMAKING.md)
> **Note:** These plugins are dependent on the [Kraken API](https://github.com/cbartram/kraken-api) and require the Kraken Client to be installed. We strongly
> recommend using the [Kraken Client](https://kraken-plugins.com/) to make testing and using these plugins simple.
# QuickStart
Because the [Kraken API](https://github.com/cbartram/kraken-api) is required on the Runtime classpath we recommend using the [Kraken Client](https://kraken-plugins.com/docs/client/download.html) to sideload the plugins
as it already loads the [Kraken API](https://github.com/cbartram/kraken-api) automatically. This ensures you don't have to write your own plugin loader! The
following steps assume you are using the Kraken client.
Instructions for setting up the Kraken Client can [be found here](https://kraken-plugins.com/docs/client/download.html).
If you'd prefer to run the plugins individually or without the Kraken Client, then each plugin has its own test file
in `{plugin}/src/test/Run{Plugin}PluginTest.java` class which will run the plugin in RuneLite. Remember to add `-ea` to
your JVM assertions!
## Run with External Repository
The Kraken client supports loading plugins from external repositories, including this one! To load these
plugins, simply add this repo as a source for the plugins.
Paste the link to the repositories latest manifest here in the dialogue:
`https://github.com/cbartram/kraken-example-plugin/releases/latest/download/manifest.json`
Once you add this repository, the plugins will be loaded automatically:
You will find your plugins in the Kraken plugins list:
## Run Sideloaded
If you would like to load all the plugins at once, you can move the built plugin jar files to `~/.runelite/kraken/sideloaded-plugins` assuming you are using the
[Kraken client](https://kraken-plugins.com/).
The plugins will be loaded in the list of Kraken plugins.
## Building
To set up your development environment, we recommend following [this guide on RuneLite's Wiki](https://github.com/runelite/runelite/wiki/Building-with-IntelliJ-IDEA).
You must add `-ea` to your VM args to enable assertions and add `--developer-mode` as an argument when you run the JAR.
Once you have the example plugin cloned and set up within Intellij, build and the plugins with:
```shell
export GITHUB_ACTOR=
export GITHUB_TOKEN=
./gradlew clean buildAndCollectSimpleJars --stacktrace --parallel
```
Your plugin jars will be built in the `./build/plugins` directory. You will need to ensure the Kraken API jar
is on RuneLite's runtime classpath in order for the plugins to load correctly.
## Gradle Kraken API
Please see [these docs](https://github.com/cbartram/kraken-api?tab=readme-ov-file#gradle-example-recommended) for including the Kraken API
as part of your RuneLite plugin's build process.
## 🛠 Built With
* [Java](https://www.java.org/) — Core language
* [Gradle](https://gradle.org/) — Build tool
* [RuneLite](https://runelite.net) — Used for as the backbone for the API
* [Kraken API](https://github.com/cbartram/kraken-api) – Interaction API
---
## 🤝 Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
---
## 🔖 Versioning
We use [Semantic Versioning](http://semver.org/).
See the [tags on this repository](https://github.com/cbartram/kraken-api/tags) for available releases.
---
## 📜 License
This project is licensed under the [GNU General Public License 3.0](LICENSE.md).
---
## 🙏 Acknowledgments
* **RuneLite** — The splash screen and much of the core codebase come from RuneLite.
* **Microbot** — For clever ideas on client and plugin interaction.
* **Packet Utils** - Plugin from Ethan Vann providing access to complex packet sending functionality which was used to develop the core.packet package of the API
[contributors-shield]: https://img.shields.io/github/contributors/cbartram/kraken-example-plugin.svg?style=for-the-badge
[contributors-url]: https://github.com/cbartram/kraken-example-plugin/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/cbartram/kraken-example-plugin.svg?style=for-the-badge
[forks-url]: https://github.com/cbartram/kraken-example-plugin/network/members
[stars-shield]: https://img.shields.io/github/stars/cbartram/kraken-example-plugin.svg?style=for-the-badge
[stars-url]: https://github.com/cbartram/kraken-example-plugin/stargazers
[issues-shield]: https://img.shields.io/github/issues/cbartram/kraken-example-plugin.svg?style=for-the-badge
[issues-url]: https://github.com/cbartram/kraken-example-plugin/issues