# kirby-teves/the_riddle_dungeon architecture

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

- Interactive diagram: https://gitdiagram.com/kirby-teves/the_riddle_dungeon
- Repository: https://github.com/kirby-teves/the_riddle_dungeon

## Overview

The Riddle Dungeon is a Java Swing escape-room game: the player progresses through six rooms by answering a guardian’s randomized riddle, managing hearts, and ultimately winning or dying. The application switches among menu, gameplay, and map views; gameplay checks answers and advances room state, while saves serialize the game manager. The README also documents difficulty tiers, guardian dialogue, hints, and map tracking. Some panel and entry-point source was only indexed, so uncertain internal links are omitted; documented capabilities remain represented.

Main entry points: [`src/mains/Application.java`](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/mains/Application.java) (Application Controller), [`src/panels/GamePanel.java`](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/GamePanel.java) (Game Panel), [`src/gamemasters/GameMaster.java`](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/gamemasters/GameMaster.java) (Game Master Base), [`src/model/GameManager.java`](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/GameManager.java) (Game Manager)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application and UI"]
  node_main["Program Entry<br/>[Main.java]"]
  node_application["Application Controller<br/>[Application.java]"]
  node_menu["Main Menu<br/>[mainMenuPanel.java]"]
  node_game_view["Game Panel<br/>[GamePanel.java]"]
  node_map_view["Map Panel<br/>[MapPanel.java]"]
end

subgraph group_play["Dungeon Gameplay"]
  node_room["Room Challenge<br/>[Room.java]"]
  node_player_state["Player Health and Progress<br/>[Player.java]"]
end

subgraph group_riddles["Riddles and Guardians"]
  node_guardian_base["Game Master Base<br/>[GameMaster.java]"]
  node_guardians["Six Guardians"]
  node_riddle_contract["Riddle Interface<br/>[IRiddle.java]"]
  node_riddle_data["Riddle Values<br/>[RiddleImpl.java]"]
  node_env_config["Riddle Configuration<br/>[.env]"]
end

subgraph group_state["Game State and Saves"]
  node_manager["Game Manager<br/>[GameManager.java]"]
  node_save_store[("Save File<br/>[FileManager.java]")]
end

node_player_actor(("Player"))

node_player_actor -->|"starts game"| node_application
node_main -->|"launches"| node_application
node_application -->|"gets instance"| node_manager
node_application -->|"creates and displays"| node_menu
node_application -->|"creates and displays"| node_game_view
node_application -->|"creates and displays"| node_map_view
node_menu -->|"requests navigation"| node_application
node_game_view -->|"checks answers"| node_room
node_game_view -->|"updates gameplay"| node_player_state
node_game_view -->|"saves progress"| node_manager
node_game_view -->|"creates room guardians"| node_guardians
node_map_view -->|"reads room progress"| node_manager
node_room -->|"gets riddle and greeting"| node_guardian_base
node_guardians -->|"inherit behavior"| node_guardian_base
node_guardian_base -->|"uses"| node_riddle_contract
node_guardian_base -->|"creates fallback"| node_riddle_data
node_guardians -->|"builds riddle pools"| node_riddle_data
node_guardian_base -->|"loads values"| node_env_config
node_manager -->|"owns"| node_player_state
node_manager -->|"saves and loads"| node_save_store
node_player_state -->|"deletes save on death"| node_save_store

click node_main "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/mains/Main.java"
click node_application "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/mains/Application.java"
click node_menu "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/mainMenuPanel.java"
click node_game_view "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/GamePanel.java"
click node_map_view "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/MapPanel.java"
click node_room "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/Room.java"
click node_player_state "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/Player.java"
click node_manager "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/GameManager.java"
click node_save_store "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/util/FileManager.java"
click node_guardian_base "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/gamemasters/GameMaster.java"
click node_guardians "https://github.com/kirby-teves/the_riddle_dungeon/tree/main/src/gamemasters"
click node_riddle_contract "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/IRiddle.java"
click node_riddle_data "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/RiddleImpl.java"
click node_env_config "https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/.env"

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_main,node_application,node_menu,node_game_view,node_map_view toneBlue
class node_room,node_player_state toneAmber
class node_guardian_base,node_guardians,node_riddle_contract,node_riddle_data,node_env_config toneMint
class node_manager,node_save_store toneRose
class node_player_actor toneIndigo
```

## Components

### Application and UI

- [Program Entry](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/mains/Main.java): `src/mains/Main.java`
- [Application Controller](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/mains/Application.java): `src/mains/Application.java`
- [Main Menu](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/mainMenuPanel.java): `src/panels/mainMenuPanel.java`
- [Game Panel](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/GamePanel.java): `src/panels/GamePanel.java`
- [Map Panel](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/panels/MapPanel.java): `src/panels/MapPanel.java`

### Dungeon Gameplay

- [Room Challenge](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/Room.java): `src/model/Room.java`
- [Player Health and Progress](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/Player.java): `src/model/Player.java`

### Riddles and Guardians

- [Game Master Base](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/gamemasters/GameMaster.java): `src/gamemasters/GameMaster.java`
- [Six Guardians](https://github.com/kirby-teves/the_riddle_dungeon/tree/main/src/gamemasters): `src/gamemasters`
- [Riddle Interface](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/IRiddle.java): `src/model/IRiddle.java`
- [Riddle Values](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/RiddleImpl.java): `src/model/RiddleImpl.java`
- [Riddle Configuration](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/.env): `src/.env`

### Game State and Saves

- [Game Manager](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/model/GameManager.java): `src/model/GameManager.java`
- [Save File](https://github.com/kirby-teves/the_riddle_dungeon/blob/main/src/util/FileManager.java): `src/util/FileManager.java`

### Other components

- **Player**

## Connections

- Player → Application Controller: starts game (evidence: `README.md`)
- Program Entry → Application Controller: launches (evidence: `src/mains/Main.java`)
- Application Controller → Game Manager: gets instance (evidence: `src/mains/Application.java`)
- Application Controller → Main Menu: creates and displays (evidence: `src/mains/Application.java`)
- Application Controller → Game Panel: creates and displays (evidence: `src/mains/Application.java`)
- Application Controller → Map Panel: creates and displays (evidence: `src/mains/Application.java`)
- Main Menu → Application Controller: requests navigation (evidence: `src/panels/mainMenuPanel.java`)
- Game Panel → Room Challenge: checks answers (evidence: `src/panels/GamePanel.java`)
- Game Panel → Player Health and Progress: updates gameplay (evidence: `src/panels/GamePanel.java`)
- Game Panel → Game Manager: saves progress (evidence: `src/panels/GamePanel.java`)
- Game Panel → Six Guardians: creates room guardians (evidence: `src/panels/GamePanel.java`)
- Map Panel → Game Manager: reads room progress (evidence: `src/panels/MapPanel.java`)
- Room Challenge → Game Master Base: gets riddle and greeting (evidence: `src/model/Room.java`)
- Six Guardians → Game Master Base: inherit behavior (evidence: `src/gamemasters/Patrick.java`)
- Game Master Base → Riddle Interface: uses (evidence: `src/gamemasters/GameMaster.java`)
- Game Master Base → Riddle Values: creates fallback (evidence: `src/gamemasters/GameMaster.java`)
- Six Guardians → Riddle Values: builds riddle pools (evidence: `src/gamemasters/Patrick.java`)
- Game Master Base → Riddle Configuration: loads values (evidence: `src/gamemasters/GameMaster.java`)
- Game Manager → Player Health and Progress: owns (evidence: `src/model/GameManager.java`)
- Game Manager → Save File: saves and loads (evidence: `src/model/GameManager.java`)
- Player Health and Progress → Save File: deletes save on death (evidence: `src/model/Player.java`)
