Microbot is a RuneLite fork with an always-on Microbot plugin for learning, building, and running automation scripts.
This README is intentionally short. Durable details live in the docs below so high-level context does not rot when implementation details move.
- Install or run a release:
docs/installation.md - Set up a development environment:
docs/development.md - Understand the runtime:
docs/ARCHITECTURE.md - Build scripts safely:
runelite-client/src/main/java/net/runelite/client/plugins/microbot/AGENTS.md - Use entity caches/queryables:
runelite-client/src/main/java/net/runelite/client/plugins/microbot/api/QUERYABLE_API.md - Drive a running client:
docs/MICROBOT_CLI.md
- Compile client:
./gradlew :client:compileJava - Run unit tests:
./gradlew :client:runUnitTests - Build all projects:
./gradlew buildAll - Build shaded jar:
./gradlew :client:assemble
- Microbot plugin and scripts:
runelite-client/src/main/java/net/runelite/client/plugins/microbot - Reusable helpers:
runelite-client/src/main/java/net/runelite/client/plugins/microbot/util - Queryable caches:
runelite-client/src/main/java/net/runelite/client/plugins/microbot/api - Runtime agent tooling:
runelite-client/src/main/java/net/runelite/client/plugins/microbot/agentserver
If you have any questions, please join our Discord server.