Microbot

Microbot is a fun Old School RuneScape side project built on RuneLite. It focuses on learning and sharing automation scripts, not enterprise software.

• Core plugin: runelite-client/src/main/java/net/runelite/client/plugins/microbot
• Queryable API docs: runelite-client/src/main/java/net/runelite/client/plugins/microbot/api/QUERYABLE_API.md (quick read: api/README.md)
• Helpers/utilities: microbot/util inside the plugin tree

Installing & Running

• Download shaded releases from the GitHub releases page (see docs/installation.md for step‑by‑step and launcher notes).
• Linux/macOS/Windows: run the shaded JAR with Java 17+ (java -jar client-<version>-SNAPSHOT-shaded.jar), or swap it into RuneLite/Bolt as described in docs/installation.md.
• Stuck? Join the Discord below.

Building from Source

• Quick compile: ./gradlew :runelite-client:compileJava
• Full build: ./gradlew build
• Main sources are included builds defined in settings.gradle.kts (cache, runelite-api, runelite-client, runelite-jshell).
• Development setup guide: docs/development.md

Developing Scripts

• New scripts belong in the microbot plugin folder: runelite-client/src/main/java/net/runelite/client/plugins/microbot.
• Share reusable helpers under microbot/util.
• Use the Queryable API caches via Microbot.getRs2XxxCache().query(); do not instantiate caches/queryables directly. See api/QUERYABLE_API.md and examples under api/*/*ApiExample.java.
• Example scripts live in runelite-client/src/main/java/net/runelite/client/plugins/microbot/example/.

Discord

If you have any questions, please join our Discord server.