# jouneri/wildy-tele-check architecture

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

- Interactive diagram: https://gitdiagram.com/jouneri/wildy-tele-check
- Repository: https://github.com/jouneri/wildy-tele-check

## Overview

Wildy Tele Check is a RuneLite plugin that detects Wilderness entry and warns when the player lacks any enabled escape teleport. Its runtime flow is event tracking, checking equipped and carried items against configurable accepted teleports, then issuing chat and sound alerts. The README documents the supported items and sound options; unsampled implementation details are represented only where documentation supports them.

Main entry points: [`src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java) (Wilderness Entry Tracking), [`src/main/java/com/wildytelecheck/WildyTeleCheckConfig.java`](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckConfig.java) (Teleport and Alert Settings), [`src/main/resources/com/wildytelecheck/default-alert.wav`](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/resources/com/wildytelecheck/default-alert.wav) (Bundled WAV)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_detection["Entry Detection"]
  node_runelite["RuneLite Client"]
  node_entry["Wilderness Entry Tracking"]
end

subgraph group_validation["Teleport Validation"]
  node_itemcheck["Escape Item Check"]
  node_settings["Teleport and Alert Settings"]
  node_inventory["Inventory and Equipment"]
end

subgraph group_alerts["Warning Alerts"]
  node_alert["Alert Dispatch"]
  node_chat["In-game Chat"]
  node_audio["Audio Playback"]
  node_bundled["Bundled WAV<br/>[default-alert.wav]"]
  node_custom["Custom WAV File"]
end

node_player(("Player"))

node_player -->|"plays in"| node_runelite
node_runelite -->|"sends game events"| node_entry
node_entry -->|"checks on entry"| node_itemcheck
node_itemcheck -->|"reads items"| node_inventory
node_settings -->|"defines accepted items"| node_itemcheck
node_entry -->|"reads alert options"| node_settings
node_entry -->|"dispatches if none found"| node_alert
node_alert -->|"shows warning text"| node_chat
node_alert -->|"plays warning sound"| node_audio
node_audio -->|"falls back to"| node_bundled
node_audio -->|"may use instead"| node_custom
node_player -->|"configures"| node_settings

click node_entry "https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java"
click node_itemcheck "https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java"
click node_settings "https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckConfig.java"
click node_alert "https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java"
click node_bundled "https://github.com/jouneri/wildy-tele-check/blob/main/src/main/resources/com/wildytelecheck/default-alert.wav"

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_runelite,node_entry toneBlue
class node_itemcheck,node_settings,node_inventory toneAmber
class node_alert,node_chat,node_audio,node_bundled,node_custom toneMint
class node_player toneIndigo
```

## Components

### Entry Detection

- **RuneLite Client**
- [Wilderness Entry Tracking](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java): `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`

### Teleport Validation

- [Escape Item Check](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java): `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`
- [Teleport and Alert Settings](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckConfig.java): `src/main/java/com/wildytelecheck/WildyTeleCheckConfig.java`
- **Inventory and Equipment**

### Warning Alerts

- [Alert Dispatch](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java): `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`
- **In-game Chat**
- **Audio Playback**
- [Bundled WAV](https://github.com/jouneri/wildy-tele-check/blob/main/src/main/resources/com/wildytelecheck/default-alert.wav): `src/main/resources/com/wildytelecheck/default-alert.wav`
- **Custom WAV File**

### Other components

- **Player**

## Connections

- Player → RuneLite Client: plays in (evidence: `README.md`)
- RuneLite Client → Wilderness Entry Tracking: sends game events (evidence: `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`)
- Wilderness Entry Tracking → Escape Item Check: checks on entry (evidence: `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`)
- Escape Item Check → Inventory and Equipment: reads items (evidence: `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`)
- Teleport and Alert Settings → Escape Item Check: defines accepted items (evidence: `README.md`)
- Wilderness Entry Tracking → Teleport and Alert Settings: reads alert options (evidence: `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`)
- Wilderness Entry Tracking → Alert Dispatch: dispatches if none found (evidence: `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`)
- Alert Dispatch → In-game Chat: shows warning text (evidence: `README.md`)
- Alert Dispatch → Audio Playback: plays warning sound (evidence: `src/main/java/com/wildytelecheck/WildyTeleCheckPlugin.java`)
- Audio Playback → Bundled WAV: falls back to (evidence: `README.md`)
- Audio Playback → Custom WAV File: may use instead (evidence: `README.md`)
- Player → Teleport and Alert Settings: configures (evidence: `README.md`)
