How runelite/runelite works
RuneLite is an OldSchool RuneScape client with a public game API, plugin-driven client runtime, and cache tooling. The principal workflow is: a player runs the client, the game engine exposes live game state through the API, and plugins transform that state into overlays, bank interfaces, world data, and social features. Sampled code confirms NPC and player analysis, world fetching, party synchronization, Discord presence, and cache storage. Several broader plugin capabilities are represented from the documented project layout, while unsampled wiring is intentionally limited.
Main entry points: PartyService.java Party Service · eventbus Event Bus · Cache.java Cache Library · client Game Client
Components 23
Client Runtime
- Game Client
runelite-client/src/main/java/net/runelite/client - Game Engine
runelite-api/src/main/java/net/runelite/api/GameEngine.java - Client API
runelite-api/src/main/java/net/runelite/api/Client.java - Plugin Runtime
runelite-client/src/main/java/net/runelite/client - Event Bus
runelite-client/src/main/java/net/runelite/client/eventbus
Game Features
- NPC Overlays
runelite-client/src/main/java/net/runelite/client/game/npcoverlay/NpcOverlayService.java - Player Indicators
runelite-client/src/main/java/net/runelite/client/plugins/playerindicators/PlayerIndicatorsService.java - World Service
runelite-client/src/main/java/net/runelite/client/game/WorldService.java - Bank Tags API
runelite-client/src/main/java/net/runelite/client/plugins/banktags/BankTagsService.java - Potion Storage
runelite-client/src/main/java/net/runelite/client/plugins/banktags/tabs/PotionStorage.java
Social Integrations
- Party Service
runelite-client/src/main/java/net/runelite/client/party/PartyService.java - Discord Service
runelite-client/src/main/java/net/runelite/client/discord/DiscordService.java
Cache Tooling
- Cache Library
cache/src/main/java/net/runelite/cache/Cache.java - Storage API
cache/src/main/java/net/runelite/cache/fs/Storage.java - Disk Storage
cache/src/main/java/net/runelite/cache/fs/jagex/DiskStorage.java - Flat Storage
cache/src/main/java/net/runelite/cache/fs/flat/FlatStorage.java - Cache Store
cache/src/main/java/net/runelite/cache/fs/Store.java - Cache Definitions
cache/src/main/java/net/runelite/cache/definitions
Other components
- Player
- Worlds API
- Party Backend
- Discord
- Cache Files
Connections 21
- Player → Game Client: runs
- Game Client → Game Engine: initializes
- Game Client → Plugin Runtime: hosts plugins
- NPC Overlays → Client API: reads NPCs
- NPC Overlays → Event Bus: subscribes
- Player Indicators → Client API: reads players
- Player Indicators → Party Service: reads party
- World Service → Worlds API: fetches worlds
- World Service → Event Bus: posts results
- Potion Storage → Client API: runs scripts
- Party Service → Party Backend: joins party
- Party Service → Event Bus: posts changes
- Party Service → Discord Service: separate integration
- Discord Service → Discord: updates presence
- Discord Service → Event Bus: posts events
- Cache Library → Cache Store: manages cache
- Disk Storage → Cache Store: adds indexes
- Disk Storage → Cache Files: reads writes
- Flat Storage → Cache Files: reads writes
- Cache Library → Storage API: uses storage
- Cache Library → Cache Definitions: exposes definitions