{"id":31485637,"url":"https://github.com/cbartram/kraken-example-plugin","last_synced_at":"2026-01-25T22:53:38.227Z","repository":{"id":310554197,"uuid":"1040315943","full_name":"cbartram/kraken-example-plugin","owner":"cbartram","description":"An example of a Kraken Plugin which utilizes RuneLite and the Kraken API to automate simple tasks.","archived":false,"fork":false,"pushed_at":"2026-01-23T20:33:33.000Z","size":1064,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-01-24T05:29:29.290Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cbartram.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-18T19:36:58.000Z","updated_at":"2026-01-23T20:33:09.000Z","dependencies_parsed_at":"2025-10-12T14:10:06.160Z","dependency_job_id":"ed7baa9c-84f8-4968-ba20-4a4b503d5d8b","html_url":"https://github.com/cbartram/kraken-example-plugin","commit_stats":null,"previous_names":["cbartram/kraken-example-plugin"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/cbartram/kraken-example-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbartram%2Fkraken-example-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbartram%2Fkraken-example-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbartram%2Fkraken-example-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbartram%2Fkraken-example-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cbartram","download_url":"https://codeload.github.com/cbartram/kraken-example-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbartram%2Fkraken-example-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28761175,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T20:56:06.009Z","status":"ssl_error","status_checked_at":"2026-01-25T20:54:48.203Z","response_time":113,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-02T10:59:07.663Z","updated_at":"2026-01-25T22:53:38.204Z","avatar_url":"https://github.com/cbartram.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://kraken-plugins.com\"\u003e\n    \u003cimg src=\"src/main/resources/kraken.png\" alt=\"Logo\" width=\"128\" height=\"128\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eKraken Example Plugins\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n   An set of example automation plugins utilizing the Kraken API\n    \u003cbr /\u003e\n\u003c/div\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n\n# Kraken Example Plugins\n\nThis repository contains examples for writing automation plugins using the [Kraken API](https://github.com/cbartram/kraken-api.git).\nThe Kraken API extends the RuneLite API with the ability to interact with various game entities, including:\n\n- Widgets (Prayers, Spells, Interfaces, etc...)\n- NPC's\n- Players\n- Ground Items\n- Game Objects\n- Equipment\n- World Hopping\n- Container Items (Inventory, Bank, etc...)\n- and more!\n\nThe Kraken API also ships with several handy features for developing automation plugins (scripts) right on top of RuneLite\nlike `TaskChain`'s, pathfinding, advanced mouse movement, abstractions for writing scripts, and network packet classes. \nThis repository contains several examples of fully functioning automation scripts showcasing the API's capabilities.\n\n### Plugin \u0026 Script Requirements\n\nYou can read more about the individual plugins, their features, and their requirements\nin their respective README's linked below.\n\n- [Mining Plugin](docs/MINING.md)\n- [Woodcutting Plugin](docs/WOODCUTTING.md)\n- [Fishing Plugin](docs/FISHING.md)\n- [Jewelry Plugin](docs/JEWELRY.md)\n- [Firemaking Plugin](docs/FIREMAKING.md)\n\n\u003e **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\n\u003e recommend using the [Kraken Client](https://kraken-plugins.com/) to make testing and using these plugins simple.\n\n# QuickStart\n\nBecause 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\nas 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\nfollowing steps assume you are using the Kraken client.\n\nInstructions for setting up the Kraken Client can [be found here](https://kraken-plugins.com/docs/client/download.html).\n\nIf you'd prefer to run the plugins individually or without the Kraken Client, then each plugin has its own test file\nin `{plugin}/src/test/Run{Plugin}PluginTest.java` class which will run the plugin in RuneLite. Remember to add `-ea` to \nyour JVM assertions!\n\n## Run with External Repository\n\nThe Kraken client supports loading plugins from external repositories, including this one! To load these \nplugins, simply add this repo as a source for the plugins.\n\n![external-repo](docs/images/add-repo.png)\n\nPaste the link to the repositories latest manifest here in the dialogue:\n\n`https://github.com/cbartram/kraken-example-plugin/releases/latest/download/manifest.json`\n\nOnce you add this repository, the plugins will be loaded automatically:\n\n![repo-loaded](docs/images/repo-loaded.png)\n\nYou will find your plugins in the Kraken plugins list:\n\n![sideloaded-plugins-list](docs/images/sideloaded.png)\n\n## Run Sideloaded\n\nIf 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 \n[Kraken client](https://kraken-plugins.com/).\n\nThe plugins will be loaded in the list of Kraken plugins.\n\n![sideloaded-plugins](docs/images/sideloaded.png)\n\n## Building\n\nTo set up your development environment, we recommend following [this guide on RuneLite's Wiki](https://github.com/runelite/runelite/wiki/Building-with-IntelliJ-IDEA).\nYou must add `-ea` to your VM args to enable assertions and add `--developer-mode` as an argument when you run the JAR. \n\nOnce you have the example plugin cloned and set up within Intellij, build and the plugins with:\n\n```shell\nexport GITHUB_ACTOR=\u003cgithub-username\u003e\nexport GITHUB_TOKEN=\u003cgithub-personal-access-token\u003e\n\n./gradlew clean buildAndCollectSimpleJars --stacktrace --parallel\n```\n\nYour plugin jars will be built in the `./build/plugins` directory. You will need to ensure the Kraken API jar \nis on RuneLite's runtime classpath in order for the plugins to load correctly.\n\n## Gradle Kraken API\n\nPlease see [these docs](https://github.com/cbartram/kraken-api?tab=readme-ov-file#gradle-example-recommended) for including the Kraken API\nas part of your RuneLite plugin's build process.\n\n## 🛠 Built With\n\n* [Java](https://www.java.org/) — Core language\n* [Gradle](https://gradle.org/) — Build tool\n* [RuneLite](https://runelite.net) — Used for as the backbone for the API\n* [Kraken API](https://github.com/cbartram/kraken-api) – Interaction API\n\n---\n\n## 🤝 Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.\n\n---\n\n## 🔖 Versioning\n\nWe use [Semantic Versioning](http://semver.org/).\nSee the [tags on this repository](https://github.com/cbartram/kraken-api/tags) for available releases.\n\n---\n\n## 📜 License\n\nThis project is licensed under the [GNU General Public License 3.0](LICENSE.md).\n\n---\n\n## 🙏 Acknowledgments\n\n* **RuneLite** — The splash screen and much of the core codebase come from RuneLite.\n* **Microbot** — For clever ideas on client and plugin interaction.\n* **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\n\n\n[contributors-shield]: https://img.shields.io/github/contributors/cbartram/kraken-example-plugin.svg?style=for-the-badge\n[contributors-url]: https://github.com/cbartram/kraken-example-plugin/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/cbartram/kraken-example-plugin.svg?style=for-the-badge\n[forks-url]: https://github.com/cbartram/kraken-example-plugin/network/members\n[stars-shield]: https://img.shields.io/github/stars/cbartram/kraken-example-plugin.svg?style=for-the-badge\n[stars-url]: https://github.com/cbartram/kraken-example-plugin/stargazers\n[issues-shield]: https://img.shields.io/github/issues/cbartram/kraken-example-plugin.svg?style=for-the-badge\n[issues-url]: https://github.com/cbartram/kraken-example-plugin/issues","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbartram%2Fkraken-example-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcbartram%2Fkraken-example-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbartram%2Fkraken-example-plugin/lists"}