# runelite/runelite architecture

> Architecture diagram of the GitHub repository runelite/runelite, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/runelite/runelite
- Repository: https://github.com/runelite/runelite

## Overview

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: [`runelite-client/src/main/java/net/runelite/client/party/PartyService.java`](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/party/PartyService.java) (Party Service), [`runelite-client/src/main/java/net/runelite/client/eventbus`](https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client/eventbus) (Event Bus), [`cache/src/main/java/net/runelite/cache/Cache.java`](https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/Cache.java) (Cache Library), [`runelite-client/src/main/java/net/runelite/client`](https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client) (Game Client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Client Runtime"]
  node_game_client["Game Client"]
  node_game_engine["Game Engine<br/>[GameEngine.java]"]
  node_client_api["Client API<br/>[Client.java]"]
  node_plugin_runtime["Plugin Runtime"]
  node_event_bus["Event Bus"]
end

subgraph group_features["Game Features"]
  node_npc_overlay["NPC Overlays"]
  node_player_indicators["Player Indicators"]
  node_world_service["World Service<br/>[WorldService.java]"]
  node_bank_tags["Bank Tags API"]
  node_potion_storage["Potion Storage<br/>[PotionStorage.java]"]
end

subgraph group_social["Social Integrations"]
  node_party_service["Party Service<br/>[PartyService.java]"]
  node_discord_service["Discord Service"]
end

subgraph group_cache["Cache Tooling"]
  node_cache_library["Cache Library<br/>[Cache.java]"]
  node_storage_api["Storage API<br/>[Storage.java]"]
  node_disk_storage["Disk Storage<br/>[DiskStorage.java]"]
  node_flat_storage["Flat Storage<br/>[FlatStorage.java]"]
  node_cache_store[("Cache Store<br/>[Store.java]")]
  node_cache_definitions["Cache Definitions"]
end

node_player(("Player"))
node_world_api["Worlds API"]
node_party_backend["Party Backend"]
node_discord["Discord"]
node_cache_files[("Cache Files")]

node_player -->|"runs"| node_game_client
node_game_client -->|"initializes"| node_game_engine
node_game_client -->|"hosts plugins"| node_plugin_runtime
node_npc_overlay -->|"reads NPCs"| node_client_api
node_npc_overlay -->|"subscribes"| node_event_bus
node_player_indicators -->|"reads players"| node_client_api
node_player_indicators -->|"reads party"| node_party_service
node_world_service -->|"fetches worlds"| node_world_api
node_world_service -->|"posts results"| node_event_bus
node_potion_storage -->|"runs scripts"| node_client_api
node_party_service -->|"joins party"| node_party_backend
node_party_service -->|"posts changes"| node_event_bus
node_party_service -.->|"separate integration"| node_discord_service
node_discord_service -.->|"updates presence"| node_discord
node_discord_service -->|"posts events"| node_event_bus
node_cache_library -->|"manages cache"| node_cache_store
node_disk_storage -->|"adds indexes"| node_cache_store
node_disk_storage -->|"reads writes"| node_cache_files
node_flat_storage -->|"reads writes"| node_cache_files
node_cache_library -->|"uses storage"| node_storage_api
node_cache_library -->|"exposes definitions"| node_cache_definitions

click node_game_client "https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client"
click node_game_engine "https://github.com/runelite/runelite/blob/master/runelite-api/src/main/java/net/runelite/api/GameEngine.java"
click node_client_api "https://github.com/runelite/runelite/blob/master/runelite-api/src/main/java/net/runelite/api/Client.java"
click node_plugin_runtime "https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client"
click node_npc_overlay "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/game/npcoverlay/NpcOverlayService.java"
click node_player_indicators "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/playerindicators/PlayerIndicatorsService.java"
click node_world_service "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/game/WorldService.java"
click node_bank_tags "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/banktags/BankTagsService.java"
click node_potion_storage "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/banktags/tabs/PotionStorage.java"
click node_party_service "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/party/PartyService.java"
click node_discord_service "https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/discord/DiscordService.java"
click node_event_bus "https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client/eventbus"
click node_cache_library "https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/Cache.java"
click node_storage_api "https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/Storage.java"
click node_disk_storage "https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/jagex/DiskStorage.java"
click node_flat_storage "https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/flat/FlatStorage.java"
click node_cache_store "https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/Store.java"
click node_cache_definitions "https://github.com/runelite/runelite/tree/master/cache/src/main/java/net/runelite/cache/definitions"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_game_client,node_game_engine,node_client_api,node_plugin_runtime,node_event_bus toneBlue
class node_npc_overlay,node_player_indicators,node_world_service,node_bank_tags,node_potion_storage,node_cache_files toneAmber
class node_party_service,node_discord_service,node_world_api toneMint
class node_cache_library,node_storage_api,node_disk_storage,node_flat_storage,node_cache_store,node_cache_definitions toneRose
class node_player,node_party_backend,node_discord toneIndigo
```

## Components

### Client Runtime

- [Game Client](https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client): `runelite-client/src/main/java/net/runelite/client`
- [Game Engine](https://github.com/runelite/runelite/blob/master/runelite-api/src/main/java/net/runelite/api/GameEngine.java): `runelite-api/src/main/java/net/runelite/api/GameEngine.java`
- [Client API](https://github.com/runelite/runelite/blob/master/runelite-api/src/main/java/net/runelite/api/Client.java): `runelite-api/src/main/java/net/runelite/api/Client.java`
- [Plugin Runtime](https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client): `runelite-client/src/main/java/net/runelite/client`
- [Event Bus](https://github.com/runelite/runelite/tree/master/runelite-client/src/main/java/net/runelite/client/eventbus): `runelite-client/src/main/java/net/runelite/client/eventbus`

### Game Features

- [NPC Overlays](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/game/npcoverlay/NpcOverlayService.java): `runelite-client/src/main/java/net/runelite/client/game/npcoverlay/NpcOverlayService.java`
- [Player Indicators](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/playerindicators/PlayerIndicatorsService.java): `runelite-client/src/main/java/net/runelite/client/plugins/playerindicators/PlayerIndicatorsService.java`
- [World Service](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/game/WorldService.java): `runelite-client/src/main/java/net/runelite/client/game/WorldService.java`
- [Bank Tags API](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/banktags/BankTagsService.java): `runelite-client/src/main/java/net/runelite/client/plugins/banktags/BankTagsService.java`
- [Potion Storage](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/banktags/tabs/PotionStorage.java): `runelite-client/src/main/java/net/runelite/client/plugins/banktags/tabs/PotionStorage.java`

### Social Integrations

- [Party Service](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/party/PartyService.java): `runelite-client/src/main/java/net/runelite/client/party/PartyService.java`
- [Discord Service](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/discord/DiscordService.java): `runelite-client/src/main/java/net/runelite/client/discord/DiscordService.java`

### Cache Tooling

- [Cache Library](https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/Cache.java): `cache/src/main/java/net/runelite/cache/Cache.java`
- [Storage API](https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/Storage.java): `cache/src/main/java/net/runelite/cache/fs/Storage.java`
- [Disk Storage](https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/jagex/DiskStorage.java): `cache/src/main/java/net/runelite/cache/fs/jagex/DiskStorage.java`
- [Flat Storage](https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/flat/FlatStorage.java): `cache/src/main/java/net/runelite/cache/fs/flat/FlatStorage.java`
- [Cache Store](https://github.com/runelite/runelite/blob/master/cache/src/main/java/net/runelite/cache/fs/Store.java): `cache/src/main/java/net/runelite/cache/fs/Store.java`
- [Cache Definitions](https://github.com/runelite/runelite/tree/master/cache/src/main/java/net/runelite/cache/definitions): `cache/src/main/java/net/runelite/cache/definitions`

### Other components

- **Player**
- **Worlds API**
- **Party Backend**
- **Discord**
- **Cache Files**

## Connections

- 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
