# terzogode/cub3d architecture

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

- Interactive diagram: https://gitdiagram.com/terzogode/cub3d
- Repository: https://github.com/terzogode/cub3d

## Overview

Cub3D is a C ray-casting game: it accepts a .cub scene, parses its textures, colors, and map, validates the map, then starts a windowed game loop. The base and bonus versions share that workflow; the bonus adds mouse look, doors, a minimap, and animated arms. The graph preserves these documented capabilities, but source excerpts do not show most engine-to-engine calls, so those relationships are omitted rather than inferred. The Libft support library is shown as a utility subsystem.

Main entry points: [`base/main.c`](https://github.com/terzogode/cub3d/blob/main/base/main.c) (Base entry), [`bonus/main.c`](https://github.com/terzogode/cub3d/blob/main/bonus/main.c) (Bonus entry), [`base/srcs/parse_file.c`](https://github.com/terzogode/cub3d/blob/main/base/srcs/parse_file.c) (Scene parsing), [`bonus/srcs/parse_file.c`](https://github.com/terzogode/cub3d/blob/main/bonus/srcs/parse_file.c) (Bonus scene parsing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Game startup"]
  node_base_main["Base entry<br/>[main.c]"]
  node_bonus_main["Bonus entry<br/>[main.c]"]
end

subgraph group_scene["Scene loading"]
  node_base_input["Input checks<br/>[validate_input.c]"]
  node_base_parse["Scene parsing<br/>[parse_file.c]"]
  node_base_read["File reading<br/>[read_file.c]"]
  node_base_elements["Texture and color<br/>[parse_texture.c]"]
  node_base_map["Map extraction<br/>[extract_map.c]"]
  node_base_validate["Map validation<br/>[validate_map.c]"]
  node_bonus_elements["Bonus scene parsing<br/>[parse_file.c]"]
end

subgraph group_base_engine["Base engine"]
  node_base_engine_init["Engine setup<br/>[init.c]"]
  node_base_input_events["Keyboard controls<br/>[key_management.c]"]
  node_base_render["Frame rendering<br/>[main_rendering.c]"]
  node_base_rays["Ray casting<br/>[ray_casting.c]"]
  node_base_draw["Wall drawing<br/>[draw.c]"]
  node_base_textures["Texture loading<br/>[texture.c]"]
end

subgraph group_bonus_engine["Bonus engine"]
  node_bonus_engine_init["Bonus setup<br/>[init.c]"]
  node_bonus_render["Bonus rendering<br/>[main_rendering.c]"]
  node_bonus_mouse["Mouse look<br/>[mouse_management.c]"]
  node_bonus_doors["Doors<br/>[doors.c]"]
  node_bonus_minimap["Minimap<br/>[minimap.c]"]
  node_bonus_arms["Animated arms<br/>[arms.c]"]
end

subgraph group_shared["Shared utilities"]
  node_libft["C utility library<br/>[libft.h]"]
end

node_user(("Player"))
node_mlx["MiniLibX"]

node_user -->|"provides scene"| node_base_main
node_base_main -->|"checks arguments"| node_base_input
node_base_main -->|"parses scene"| node_base_parse
node_base_parse -->|"loads file"| node_base_read
node_base_parse -->|"parses elements"| node_base_elements
node_base_parse -->|"extracts map"| node_base_map
node_base_main -->|"validates map"| node_base_validate
node_base_main -->|"initializes game"| node_base_engine_init
node_base_main -->|"loads textures"| node_base_textures
node_base_main -->|"registers keys"| node_base_input_events
node_base_main -->|"registers loop"| node_base_render
node_base_main -->|"starts event loop"| node_mlx
node_user -->|"provides scene"| node_bonus_main
node_bonus_main -->|"checks arguments"| node_base_input
node_bonus_main -->|"parses scene"| node_bonus_elements
node_bonus_elements -.->|"loads file"| node_base_read
node_bonus_elements -->|"extracts map"| node_base_map
node_bonus_main -->|"validates map"| node_base_validate
node_bonus_main -->|"initializes game"| node_bonus_engine_init
node_bonus_main -.->|"loads textures"| node_base_textures
node_bonus_main -->|"registers mouse"| node_bonus_mouse
node_bonus_main -->|"registers loop"| node_bonus_render
node_bonus_main -->|"starts event loop"| node_mlx
node_base_main -.->|"uses utilities"| node_libft
node_bonus_main -.->|"uses utilities"| node_libft

click node_base_main "https://github.com/terzogode/cub3d/blob/main/base/main.c"
click node_bonus_main "https://github.com/terzogode/cub3d/blob/main/bonus/main.c"
click node_base_input "https://github.com/terzogode/cub3d/blob/main/base/srcs/validate_input.c"
click node_base_parse "https://github.com/terzogode/cub3d/blob/main/base/srcs/parse_file.c"
click node_base_read "https://github.com/terzogode/cub3d/blob/main/base/srcs/read_file.c"
click node_base_elements "https://github.com/terzogode/cub3d/blob/main/base/srcs/parse_texture.c"
click node_base_map "https://github.com/terzogode/cub3d/blob/main/base/srcs/extract_map.c"
click node_base_validate "https://github.com/terzogode/cub3d/blob/main/base/srcs/validate_map.c"
click node_base_engine_init "https://github.com/terzogode/cub3d/blob/main/base/engine/init.c"
click node_base_input_events "https://github.com/terzogode/cub3d/blob/main/base/engine/key_management.c"
click node_base_render "https://github.com/terzogode/cub3d/blob/main/base/engine/main_rendering.c"
click node_base_rays "https://github.com/terzogode/cub3d/blob/main/base/engine/ray_casting.c"
click node_base_draw "https://github.com/terzogode/cub3d/blob/main/base/engine/draw.c"
click node_base_textures "https://github.com/terzogode/cub3d/blob/main/base/engine/texture.c"
click node_bonus_elements "https://github.com/terzogode/cub3d/blob/main/bonus/srcs/parse_file.c"
click node_bonus_engine_init "https://github.com/terzogode/cub3d/blob/main/bonus/engine/init.c"
click node_bonus_render "https://github.com/terzogode/cub3d/blob/main/bonus/engine/main_rendering.c"
click node_bonus_mouse "https://github.com/terzogode/cub3d/blob/main/bonus/engine/mouse_management.c"
click node_bonus_doors "https://github.com/terzogode/cub3d/blob/main/bonus/engine/doors.c"
click node_bonus_minimap "https://github.com/terzogode/cub3d/blob/main/bonus/engine/minimap.c"
click node_bonus_arms "https://github.com/terzogode/cub3d/blob/main/bonus/engine/arms.c"
click node_libft "https://github.com/terzogode/cub3d/blob/main/Libft/libft.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_base_main,node_bonus_main toneBlue
class node_base_input,node_base_parse,node_base_read,node_base_elements,node_base_map,node_base_validate,node_bonus_elements toneAmber
class node_base_engine_init,node_base_input_events,node_base_render,node_base_rays,node_base_draw,node_base_textures toneMint
class node_bonus_engine_init,node_bonus_render,node_bonus_mouse,node_bonus_doors,node_bonus_minimap,node_bonus_arms toneRose
class node_libft,node_user,node_mlx toneIndigo
```

## Components

### Game startup

- [Base entry](https://github.com/terzogode/cub3d/blob/main/base/main.c): `base/main.c`
- [Bonus entry](https://github.com/terzogode/cub3d/blob/main/bonus/main.c): `bonus/main.c`

### Scene loading

- [Input checks](https://github.com/terzogode/cub3d/blob/main/base/srcs/validate_input.c): `base/srcs/validate_input.c`
- [Scene parsing](https://github.com/terzogode/cub3d/blob/main/base/srcs/parse_file.c): `base/srcs/parse_file.c`
- [File reading](https://github.com/terzogode/cub3d/blob/main/base/srcs/read_file.c): `base/srcs/read_file.c`
- [Texture and color](https://github.com/terzogode/cub3d/blob/main/base/srcs/parse_texture.c): `base/srcs/parse_texture.c`
- [Map extraction](https://github.com/terzogode/cub3d/blob/main/base/srcs/extract_map.c): `base/srcs/extract_map.c`
- [Map validation](https://github.com/terzogode/cub3d/blob/main/base/srcs/validate_map.c): `base/srcs/validate_map.c`
- [Bonus scene parsing](https://github.com/terzogode/cub3d/blob/main/bonus/srcs/parse_file.c): `bonus/srcs/parse_file.c`

### Base engine

- [Engine setup](https://github.com/terzogode/cub3d/blob/main/base/engine/init.c): `base/engine/init.c`
- [Keyboard controls](https://github.com/terzogode/cub3d/blob/main/base/engine/key_management.c): `base/engine/key_management.c`
- [Frame rendering](https://github.com/terzogode/cub3d/blob/main/base/engine/main_rendering.c): `base/engine/main_rendering.c`
- [Ray casting](https://github.com/terzogode/cub3d/blob/main/base/engine/ray_casting.c): `base/engine/ray_casting.c`
- [Wall drawing](https://github.com/terzogode/cub3d/blob/main/base/engine/draw.c): `base/engine/draw.c`
- [Texture loading](https://github.com/terzogode/cub3d/blob/main/base/engine/texture.c): `base/engine/texture.c`

### Bonus engine

- [Bonus setup](https://github.com/terzogode/cub3d/blob/main/bonus/engine/init.c): `bonus/engine/init.c`
- [Bonus rendering](https://github.com/terzogode/cub3d/blob/main/bonus/engine/main_rendering.c): `bonus/engine/main_rendering.c`
- [Mouse look](https://github.com/terzogode/cub3d/blob/main/bonus/engine/mouse_management.c): `bonus/engine/mouse_management.c`
- [Doors](https://github.com/terzogode/cub3d/blob/main/bonus/engine/doors.c): `bonus/engine/doors.c`
- [Minimap](https://github.com/terzogode/cub3d/blob/main/bonus/engine/minimap.c): `bonus/engine/minimap.c`
- [Animated arms](https://github.com/terzogode/cub3d/blob/main/bonus/engine/arms.c): `bonus/engine/arms.c`

### Shared utilities

- [C utility library](https://github.com/terzogode/cub3d/blob/main/Libft/libft.h): `Libft/libft.h`

### Other components

- **Player**
- **MiniLibX**

## Connections

- Player → Base entry: provides scene
- Base entry → Input checks: checks arguments (evidence: `base/main.c`)
- Base entry → Scene parsing: parses scene (evidence: `base/main.c`)
- Scene parsing → File reading: loads file (evidence: `base/srcs/parse_file.c`)
- Scene parsing → Texture and color: parses elements (evidence: `base/srcs/parse_file.c`)
- Scene parsing → Map extraction: extracts map (evidence: `base/srcs/parse_file.c`)
- Base entry → Map validation: validates map (evidence: `base/main.c`)
- Base entry → Engine setup: initializes game (evidence: `base/main.c`)
- Base entry → Texture loading: loads textures (evidence: `base/main.c`)
- Base entry → Keyboard controls: registers keys (evidence: `base/main.c`)
- Base entry → Frame rendering: registers loop (evidence: `base/main.c`)
- Base entry → MiniLibX: starts event loop (evidence: `base/main.c`)
- Player → Bonus entry: provides scene
- Bonus entry → Input checks: checks arguments (evidence: `bonus/main.c`)
- Bonus entry → Bonus scene parsing: parses scene (evidence: `bonus/main.c`)
- Bonus scene parsing → File reading: loads file
- Bonus scene parsing → Map extraction: extracts map (evidence: `bonus/srcs/parse_file.c`)
- Bonus entry → Map validation: validates map (evidence: `bonus/main.c`)
- Bonus entry → Bonus setup: initializes game (evidence: `bonus/main.c`)
- Bonus entry → Texture loading: loads textures
- Bonus entry → Mouse look: registers mouse (evidence: `bonus/main.c`)
- Bonus entry → Bonus rendering: registers loop (evidence: `bonus/main.c`)
- Bonus entry → MiniLibX: starts event loop (evidence: `bonus/main.c`)
- Base entry → C utility library: uses utilities
- Bonus entry → C utility library: uses utilities
