Setting Up Your IDE, Maven, and Gradle
This page shows how to configure a plugin project so it compiles against the TwiLite API
Writing a Plugin
Plugins extend dev.twilite.client.plugins.Plugin and are discovered through @PluginDescriptor.
Plugin Scopes
Plugin scopes tell the client how a plugin should be scheduled with other plugins.
Config System
Plugin configs extend dev.twilite.client.config.Config. Fields are rendered in the configuration panel when they use config annotations.
Overlay System
The annotation overlay system lets plugins draw HUD text, rates, skill stats, world tiles, and world areas without writing a custom renderer.
Game API
This page covers the parts of the API that are easy to misuse. It is not a class-by-class reference.
Loadouts
Loadouts are item-id based helpers for preparing inventory, equipment, and rune pouches.
Restocking
Restocker is a Grand Exchange helper that works with loadout depletion listeners.
Simulation API
The simulation API is for short, tick-based decisions where a plugin needs to choose a movement tile or action signal before clicking.
Realtime WebSockets and Muling
TwiLite exposes a realtime WebSocket API for plugin coordination.
IPC API
TwiLite exposes a local Windows named-pipe IPC API for external tools that need to inspect or control running clients.