# whiteblobbob/arcanum-dungeon architecture

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

- Interactive diagram: https://gitdiagram.com/whiteblobbob/arcanum-dungeon
- Repository: https://github.com/whiteblobbob/arcanum-dungeon

## Overview

Arcanum is an endless terminal dungeon game. Its main workflow starts at the terminal menu: create or load a player save, enter the dungeon, fight floor-scaled enemies, and persist progression after combat victories. Audio is an internal presentation layer used by the menu and combat. The graph reflects only relationships visible in the excerpts or README; several combat details and utility implementations were not sampled.

Main entry points: [`main.c`](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/main.c) (Game menu), [`combat.c`](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/combat.c) (Turn combat), [`dungeon.c`](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/dungeon.c) (Dungeon floors), [`sound.c`](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/sound.c) (Audio engine)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_gameplay["Game flow"]
  node_menu["Game menu<br/>[main.c]"]
  node_dungeon["Dungeon floors<br/>[dungeon.c]"]
  node_combat["Turn combat<br/>[combat.c]"]
end

subgraph group_systems["Game systems"]
  node_player_data["Player state<br/>[shared.h]"]
  node_save_data[("Save files<br/>[storage.c]")]
  node_utilities["Terminal utilities<br/>[utils.c]"]
end

subgraph group_audio["Audio"]
  node_audio_api["Audio controls<br/>[sound.h]"]
  node_audio_engine["Audio engine<br/>[sound.c]"]
  node_audio_library["MiniAudio<br/>[miniaudio.h]"]
end

node_player(("Terminal player"))

node_player -->|"chooses"| node_menu
node_menu -->|"starts audio"| node_audio_engine
node_menu -->|"creates or loads"| node_save_data
node_menu -->|"enters"| node_dungeon
node_menu -->|"initializes"| node_player_data
node_dungeon -->|"starts fights"| node_combat
node_dungeon -->|"passes state"| node_player_data
node_combat -->|"saves progress"| node_save_data
node_combat -->|"plays cues"| node_audio_engine
node_combat -->|"clears screen"| node_utilities
node_audio_engine -->|"uses"| node_audio_library

click node_menu "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/main.c"
click node_dungeon "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/dungeon.c"
click node_combat "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/combat.c"
click node_player_data "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/shared.h"
click node_save_data "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/storage.c"
click node_utilities "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/utils.c"
click node_audio_api "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/sound.h"
click node_audio_engine "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/sound.c"
click node_audio_library "https://github.com/whiteblobbob/arcanum-dungeon/blob/master/miniaudio.h"

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_menu,node_dungeon,node_combat toneBlue
class node_player_data,node_save_data,node_utilities toneAmber
class node_audio_api,node_audio_engine,node_audio_library toneMint
class node_player toneIndigo
```

## Components

### Game flow

- [Game menu](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/main.c): `main.c`
- [Dungeon floors](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/dungeon.c): `dungeon.c`
- [Turn combat](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/combat.c): `combat.c`

### Game systems

- [Player state](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/shared.h): `shared.h`
- [Save files](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/storage.c): `storage.c`
- [Terminal utilities](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/utils.c): `utils.c`

### Audio

- [Audio controls](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/sound.h): `sound.h`
- [Audio engine](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/sound.c): `sound.c`
- [MiniAudio](https://github.com/whiteblobbob/arcanum-dungeon/blob/master/miniaudio.h): `miniaudio.h`

### Other components

- **Terminal player**

## Connections

- Terminal player → Game menu: chooses (evidence: `main.c`)
- Game menu → Audio engine: starts audio (evidence: `main.c`)
- Game menu → Save files: creates or loads (evidence: `main.c`)
- Game menu → Dungeon floors: enters (evidence: `main.c`)
- Game menu → Player state: initializes (evidence: `main.c`)
- Dungeon floors → Turn combat: starts fights (evidence: `dungeon.c`)
- Dungeon floors → Player state: passes state (evidence: `dungeon.c`)
- Turn combat → Save files: saves progress (evidence: `combat.c`)
- Turn combat → Audio engine: plays cues (evidence: `combat.c`)
- Turn combat → Terminal utilities: clears screen (evidence: `combat.c`)
- Audio engine → MiniAudio: uses (evidence: `sound.c`)
