# oreocupcakes/kotori-plugins architecture

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

- Interactive diagram: https://gitdiagram.com/oreocupcakes/kotori-plugins
- Repository: https://github.com/oreocupcakes/kotori-plugins

## Overview

This repository is a suite of RuneLite plugins for Old School RuneScape, plus shared Kotori utilities. A player encounters game-state-aware helpers through RuneLite: plugin event handlers interpret boss, activity, or player state, then show overlays/timers or assist with prayers and actions. Distinct branches cover boss encounters, combat/activity guidance, and player-effect tracking. The README only identifies the repository as ported OpenOSRS plugins; most subsystem links below are inferred from the file tree and remain unverified where source was not sampled.

Main entry points: [`cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java`](https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java) (Cerberus helper), [`effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java`](https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java) (Effect timers), [`alchemicalhelper/src/main/java/com/theplug/kotori/alchemicalhelper/AlchemicalHelperPlugin.java`](https://github.com/oreocupcakes/kotori-plugins/blob/master/alchemicalhelper/src/main/java/com/theplug/kotori/alchemicalhelper/AlchemicalHelperPlugin.java) (Alchemical Hydra), [`gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/GauntletHelperPlugin.java`](https://github.com/oreocupcakes/kotori-plugins/blob/master/gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/GauntletHelperPlugin.java) (Gauntlet helper)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_encounter["Boss encounters"]
  node_cerb["Cerberus helper"]
  node_cerbmodel["Cerberus phases<br/>[Phase.java]"]
  node_cerboverlay["Cerberus overlays"]
  node_hydra["Alchemical Hydra"]
  node_vorkath["Vorkath guidance<br/>[VorkathPlugin.java]"]
  node_zulrah["Zulrah guidance<br/>[ZulrahPlugin.java]"]
  node_sire["Sire guidance"]
  node_nightmare["Nightmare guidance"]
  node_nex["Nex guidance<br/>[NexPlugin.java]"]
  node_gwd["God Wars helper"]
end

subgraph group_activity["Activities and navigation"]
  node_gauntlet["Gauntlet helper"]
  node_resources["Resource tracking"]
  node_hallowed["Hallowed Sepulchre"]
  node_tarn["Tarn's Lair"]
  node_temple["Temple Trekking"]
end

subgraph group_combat["Combat guidance"]
  node_fightcaves["Fight Caves"]
  node_inferno["Inferno guidance<br/>[InfernoPlugin.java]"]
  node_aoe["Area warnings"]
end

subgraph group_shared["Effect tracking and utilities"]
  node_timers["Effect timers"]
  node_timerstore["Timer manager<br/>[TimerManager.java]"]
  node_timer["Effect timer<br/>[Timer.java]"]
  node_utils["Kotori utilities<br/>[KotoriUtils.java]"]
  node_bfs["Safe-tile search"]
end

node_player(("RuneLite player"))
node_game(("Game state"))

node_player -.->|"plays through"| node_game
node_game -.->|"emits events"| node_cerb
node_cerb -->|"updates phases"| node_cerbmodel
node_cerb -->|"registers overlays"| node_cerboverlay
node_cerb -->|"assists prayers"| node_player
node_game -.->|"emits events"| node_hydra
node_hydra -.->|"searches safe tiles"| node_bfs
node_game -.->|"emits events"| node_vorkath
node_game -.->|"emits events"| node_zulrah
node_game -.->|"emits events"| node_sire
node_game -.->|"emits events"| node_nightmare
node_game -.->|"emits events"| node_nex
node_game -.->|"emits events"| node_gwd
node_game -.->|"emits events"| node_gauntlet
node_gauntlet -->|"tracks resources"| node_resources
node_game -.->|"emits events"| node_hallowed
node_game -.->|"emits events"| node_tarn
node_game -.->|"emits events"| node_temple
node_game -.->|"emits events"| node_fightcaves
node_game -.->|"emits events"| node_inferno
node_game -.->|"emits events"| node_aoe
node_game -.->|"emits events"| node_timers
node_timers -->|"adds timers"| node_timerstore
node_timerstore -->|"stores timers"| node_timer
node_timers -.->|"shows timer overlay"| node_player
node_cerb -->|"uses utilities"| node_utils
node_timers -->|"uses utilities"| node_utils

click node_cerb "https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java"
click node_cerbmodel "https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/domain/Phase.java"
click node_cerboverlay "https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/overlays/CurrentAttackOverlay.java"
click node_hydra "https://github.com/oreocupcakes/kotori-plugins/blob/master/alchemicalhelper/src/main/java/com/theplug/kotori/alchemicalhelper/AlchemicalHelperPlugin.java"
click node_vorkath "https://github.com/oreocupcakes/kotori-plugins/blob/master/vorkathoverlay/src/main/java/com/theplug/kotori/vorkathoverlay/VorkathPlugin.java"
click node_zulrah "https://github.com/oreocupcakes/kotori-plugins/blob/master/zulrahoverlay/src/main/java/com/theplug/kotori/zulrahoverlay/ZulrahPlugin.java"
click node_sire "https://github.com/oreocupcakes/kotori-plugins/blob/master/sirehelper/src/main/java/com/theplug/kotori/sirehelper/SireHelperPlugin.java"
click node_nightmare "https://github.com/oreocupcakes/kotori-plugins/blob/master/nightmare/src/main/java/com/theplug/kotori/nightmare/NightmarePlugin.java"
click node_nex "https://github.com/oreocupcakes/kotori-plugins/blob/master/nex/src/main/java/com/theplug/kotori/nex/NexPlugin.java"
click node_gwd "https://github.com/oreocupcakes/kotori-plugins/blob/master/gwdhelper/src/main/java/com/theplug/kotori/gwdhelper/GodWarsHelperPlugin.java"
click node_gauntlet "https://github.com/oreocupcakes/kotori-plugins/blob/master/gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/GauntletHelperPlugin.java"
click node_resources "https://github.com/oreocupcakes/kotori-plugins/blob/master/gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/module/maze/ResourceManager.java"
click node_hallowed "https://github.com/oreocupcakes/kotori-plugins/blob/master/hallowedhelper/src/main/java/com/theplug/kotori/hallowedhelper/HallowedHelperPlugin.java"
click node_tarn "https://github.com/oreocupcakes/kotori-plugins/blob/master/tarnslair/src/main/java/com/theplug/kotori/tarnslair/TarnsLairPlugin.java"
click node_temple "https://github.com/oreocupcakes/kotori-plugins/blob/master/templetrekking/src/main/java/com/theplug/kotori/templetrekking/TempleTrekkingPlugin.java"
click node_fightcaves "https://github.com/oreocupcakes/kotori-plugins/blob/master/fightcaves/src/main/java/com/theplug/kotori/fightcaves/FightCavePlugin.java"
click node_inferno "https://github.com/oreocupcakes/kotori-plugins/blob/master/inferno/src/main/java/com/theplug/kotori/inferno/InfernoPlugin.java"
click node_aoe "https://github.com/oreocupcakes/kotori-plugins/blob/master/aoewarnings/src/main/java/com/theplug/kotori/aoewarnings/AoeWarningPlugin.java"
click node_timers "https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java"
click node_timerstore "https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/TimerManager.java"
click node_timer "https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/Timer.java"
click node_utils "https://github.com/oreocupcakes/kotori-plugins/blob/master/kotoriutils/src/main/java/com/theplug/kotori/kotoriutils/KotoriUtils.java"
click node_bfs "https://github.com/oreocupcakes/kotori-plugins/blob/master/kotoriutils/src/main/java/com/theplug/kotori/kotoriutils/methods/BreadthFirstSearch.java"

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_cerb,node_cerbmodel,node_cerboverlay,node_hydra,node_vorkath,node_zulrah,node_sire,node_nightmare,node_nex,node_gwd toneBlue
class node_gauntlet,node_resources,node_hallowed,node_tarn,node_temple toneAmber
class node_fightcaves,node_inferno,node_aoe toneMint
class node_timers,node_timerstore,node_timer,node_utils,node_bfs toneRose
class node_player,node_game toneIndigo
```

## Components

### Boss encounters

- [Cerberus helper](https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java): `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java`
- [Cerberus phases](https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/domain/Phase.java): `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/domain/Phase.java`
- [Cerberus overlays](https://github.com/oreocupcakes/kotori-plugins/blob/master/cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/overlays/CurrentAttackOverlay.java): `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/overlays/CurrentAttackOverlay.java`
- [Alchemical Hydra](https://github.com/oreocupcakes/kotori-plugins/blob/master/alchemicalhelper/src/main/java/com/theplug/kotori/alchemicalhelper/AlchemicalHelperPlugin.java): `alchemicalhelper/src/main/java/com/theplug/kotori/alchemicalhelper/AlchemicalHelperPlugin.java`
- [Vorkath guidance](https://github.com/oreocupcakes/kotori-plugins/blob/master/vorkathoverlay/src/main/java/com/theplug/kotori/vorkathoverlay/VorkathPlugin.java): `vorkathoverlay/src/main/java/com/theplug/kotori/vorkathoverlay/VorkathPlugin.java`
- [Zulrah guidance](https://github.com/oreocupcakes/kotori-plugins/blob/master/zulrahoverlay/src/main/java/com/theplug/kotori/zulrahoverlay/ZulrahPlugin.java): `zulrahoverlay/src/main/java/com/theplug/kotori/zulrahoverlay/ZulrahPlugin.java`
- [Sire guidance](https://github.com/oreocupcakes/kotori-plugins/blob/master/sirehelper/src/main/java/com/theplug/kotori/sirehelper/SireHelperPlugin.java): `sirehelper/src/main/java/com/theplug/kotori/sirehelper/SireHelperPlugin.java`
- [Nightmare guidance](https://github.com/oreocupcakes/kotori-plugins/blob/master/nightmare/src/main/java/com/theplug/kotori/nightmare/NightmarePlugin.java): `nightmare/src/main/java/com/theplug/kotori/nightmare/NightmarePlugin.java`
- [Nex guidance](https://github.com/oreocupcakes/kotori-plugins/blob/master/nex/src/main/java/com/theplug/kotori/nex/NexPlugin.java): `nex/src/main/java/com/theplug/kotori/nex/NexPlugin.java`
- [God Wars helper](https://github.com/oreocupcakes/kotori-plugins/blob/master/gwdhelper/src/main/java/com/theplug/kotori/gwdhelper/GodWarsHelperPlugin.java): `gwdhelper/src/main/java/com/theplug/kotori/gwdhelper/GodWarsHelperPlugin.java`

### Activities and navigation

- [Gauntlet helper](https://github.com/oreocupcakes/kotori-plugins/blob/master/gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/GauntletHelperPlugin.java): `gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/GauntletHelperPlugin.java`
- [Resource tracking](https://github.com/oreocupcakes/kotori-plugins/blob/master/gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/module/maze/ResourceManager.java): `gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/module/maze/ResourceManager.java`
- [Hallowed Sepulchre](https://github.com/oreocupcakes/kotori-plugins/blob/master/hallowedhelper/src/main/java/com/theplug/kotori/hallowedhelper/HallowedHelperPlugin.java): `hallowedhelper/src/main/java/com/theplug/kotori/hallowedhelper/HallowedHelperPlugin.java`
- [Tarn's Lair](https://github.com/oreocupcakes/kotori-plugins/blob/master/tarnslair/src/main/java/com/theplug/kotori/tarnslair/TarnsLairPlugin.java): `tarnslair/src/main/java/com/theplug/kotori/tarnslair/TarnsLairPlugin.java`
- [Temple Trekking](https://github.com/oreocupcakes/kotori-plugins/blob/master/templetrekking/src/main/java/com/theplug/kotori/templetrekking/TempleTrekkingPlugin.java): `templetrekking/src/main/java/com/theplug/kotori/templetrekking/TempleTrekkingPlugin.java`

### Combat guidance

- [Fight Caves](https://github.com/oreocupcakes/kotori-plugins/blob/master/fightcaves/src/main/java/com/theplug/kotori/fightcaves/FightCavePlugin.java): `fightcaves/src/main/java/com/theplug/kotori/fightcaves/FightCavePlugin.java`
- [Inferno guidance](https://github.com/oreocupcakes/kotori-plugins/blob/master/inferno/src/main/java/com/theplug/kotori/inferno/InfernoPlugin.java): `inferno/src/main/java/com/theplug/kotori/inferno/InfernoPlugin.java`
- [Area warnings](https://github.com/oreocupcakes/kotori-plugins/blob/master/aoewarnings/src/main/java/com/theplug/kotori/aoewarnings/AoeWarningPlugin.java): `aoewarnings/src/main/java/com/theplug/kotori/aoewarnings/AoeWarningPlugin.java`

### Effect tracking and utilities

- [Effect timers](https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java): `effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java`
- [Timer manager](https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/TimerManager.java): `effecttimers/src/main/java/com/theplug/kotori/effecttimers/TimerManager.java`
- [Effect timer](https://github.com/oreocupcakes/kotori-plugins/blob/master/effecttimers/src/main/java/com/theplug/kotori/effecttimers/Timer.java): `effecttimers/src/main/java/com/theplug/kotori/effecttimers/Timer.java`
- [Kotori utilities](https://github.com/oreocupcakes/kotori-plugins/blob/master/kotoriutils/src/main/java/com/theplug/kotori/kotoriutils/KotoriUtils.java): `kotoriutils/src/main/java/com/theplug/kotori/kotoriutils/KotoriUtils.java`
- [Safe-tile search](https://github.com/oreocupcakes/kotori-plugins/blob/master/kotoriutils/src/main/java/com/theplug/kotori/kotoriutils/methods/BreadthFirstSearch.java): `kotoriutils/src/main/java/com/theplug/kotori/kotoriutils/methods/BreadthFirstSearch.java`

### Other components

- **RuneLite player**
- **Game state**

## Connections

- RuneLite player → Game state: plays through
- Game state → Cerberus helper: emits events
- Cerberus helper → Cerberus phases: updates phases (evidence: `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java`)
- Cerberus helper → Cerberus overlays: registers overlays (evidence: `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java`)
- Cerberus helper → RuneLite player: assists prayers (evidence: `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java`)
- Game state → Alchemical Hydra: emits events
- Alchemical Hydra → Safe-tile search: searches safe tiles (evidence: `alchemicalhelper/src/main/java/com/theplug/kotori/alchemicalhelper/AlchemicalHelperPlugin.java`)
- Game state → Vorkath guidance: emits events
- Game state → Zulrah guidance: emits events
- Game state → Sire guidance: emits events
- Game state → Nightmare guidance: emits events
- Game state → Nex guidance: emits events
- Game state → God Wars helper: emits events
- Game state → Gauntlet helper: emits events
- Gauntlet helper → Resource tracking: tracks resources (evidence: `gauntlethelper/src/main/java/com/theplug/kotori/gauntlethelper/module/maze/ResourceManager.java`)
- Game state → Hallowed Sepulchre: emits events
- Game state → Tarn's Lair: emits events
- Game state → Temple Trekking: emits events
- Game state → Fight Caves: emits events
- Game state → Inferno guidance: emits events
- Game state → Area warnings: emits events
- Game state → Effect timers: emits events
- Effect timers → Timer manager: adds timers (evidence: `effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java`)
- Timer manager → Effect timer: stores timers (evidence: `effecttimers/src/main/java/com/theplug/kotori/effecttimers/TimerManager.java`)
- Effect timers → RuneLite player: shows timer overlay
- Cerberus helper → Kotori utilities: uses utilities (evidence: `cerberushelper/src/main/java/com/theplug/kotori/cerberushelper/CerberusHelperPlugin.java`)
- Effect timers → Kotori utilities: uses utilities (evidence: `effecttimers/src/main/java/com/theplug/kotori/effecttimers/EffectTimersPlugin.java`)
