# s-ike/cub3d architecture

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

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

## Overview

##### Project type and purpose
- This is a native C ray-casting “game engine” that reads a text map file (.cub), parses settings, textures, and map layout, then uses a ray-casting algorithm to render a 3D scene in an OS window (Wolfenstein-like demo).
- It’s not a web app or microservice. It’s a single-process graphical application built with MiniLibX (MLX) and a custom utility library (libft).

##### File structure
Top-level directories & files:
- includes / includes_bonus: public C headers for core and bonus features
- libft: standalone utility library (strings, memory, lists, etc.)
- srcs / srcs_bonus: core and bonus implementations, subdivided by feature (calc, file, utils), plus main.c
- textures: static XPM image assets
- test: sample .cub configuration files
- Makefile / .gitignore / README.md

Key patterns & modules:
- Ray-casting engine (srcs/calc): wall casting, floor casting, sprite casting
- Input handling & update (srcs/key_press.c, srcs/key_update.c)
- Utility layers: libft, bitmap utilities, get_line, etc.

##### README for additional insights
- Simple usage: `make && ./cub3D test/test02.cub`

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Startup Phase
    subgraph "Startup Phase"
        FS["OS File System"]:::io
        Parser["Map Parser & Validator"]:::io
        Config["Configuration Loader"]:::io
        TextureStore["Texture Store"]:::assets
        Memory["In-Memory Settings/Map Data"]:::io
    end
    FS -->|reads .cub| Parser
    Parser -->|extracts settings| Config
    Config -->|loads textures/colors| TextureStore
    TextureStore -->|provides assets| Memory
    Parser -->|validates map| Memory

    %% Runtime Loop
    subgraph "Runtime Loop"
        Input["Input Handler"]:::core
        State["State Updater"]:::core
        Renderer["Ray-Casting Renderer"]:::core
        Buffer["Pixel Buffer"]:::core
        MLXWindow["MLX Window"]:::external
    end
    MLXWindow -->|event callbacks| Input
    Input -->|updates player state| State
    State -->|feeds state| Renderer
    Renderer -->|renders frame| Buffer
    Buffer -->|pushes to window| MLXWindow

    %% Main / Entry
    Main["Game Loop & Entry Point"]:::core
    Main -->|initializes| Parser
    Main -->|starts loop| Input

    %% Assets & Tests
    subgraph "Assets & Tests"
        TexturesNode["textures/"]:::assets
        TestMaps["test/"]:::assets
    end
    TexturesNode -->|static XPM| TextureStore
    TestMaps -->|sample .cub| FS

    %% Libraries & Utilities
    subgraph "Libraries"
        libft["libft"]:::lib
        utils["Low-level Utilities"]:::lib
        Headers["Public Headers"]:::lib
        Bonus["Bonus Modules"]:::lib
    end
    libft -->|util functions| Parser
    libft -->|util functions| Config
    libft -->|util functions| Renderer
    libft -->|util functions| Input
    utils -->|get_line/bitmap/etc| Parser
    Headers -->|exposes APIs| Parser
    Bonus -->|parallel features| Parser

    MLX["MiniLibX (MLX)"]:::external
    MLX -->|window & buffer| MLXWindow
    MLX -->|keyboard events| Input

    %% Click Events
    click Parser "https://github.com/s-ike/cub3d/blob/master/srcs/file/cubfile.c"
    click Parser "https://github.com/s-ike/cub3d/blob/master/srcs/file/map.c"
    click Parser "https://github.com/s-ike/cub3d/blob/master/srcs/file/map_validation.c"
    click Config "https://github.com/s-ike/cub3d/blob/master/srcs/file/get_resolution.c"
    click Config "https://github.com/s-ike/cub3d/blob/master/srcs/file/get_textures.c"
    click Config "https://github.com/s-ike/cub3d/blob/master/srcs/file/get_colors.c"
    click Config "https://github.com/s-ike/cub3d/blob/master/srcs/file/get_settings.c"
    click TextureStore "https://github.com/s-ike/cub3d/tree/master/textures/"
    click Renderer "https://github.com/s-ike/cub3d/blob/master/srcs/calc/calc.c"
    click Renderer "https://github.com/s-ike/cub3d/blob/master/srcs/calc/wall_casting.c"
    click Renderer "https://github.com/s-ike/cub3d/blob/master/srcs/calc/floor_casting.c"
    click Renderer "https://github.com/s-ike/cub3d/blob/master/srcs/calc/sprite_casting.c"
    click Main "https://github.com/s-ike/cub3d/blob/master/srcs/main.c"
    click Main "https://github.com/s-ike/cub3d/blob/master/srcs/info.c"
    click Input "https://github.com/s-ike/cub3d/blob/master/srcs/key_press.c"
    click Input "https://github.com/s-ike/cub3d/blob/master/srcs/key_update.c"
    click Input "https://github.com/s-ike/cub3d/blob/master/srcs/sprite_list.c"
    click MLXWindow "https://github.com/s-ike/cub3d/blob/master/srcs/draw.c"
    click MLXWindow "https://github.com/s-ike/cub3d/blob/master/srcs/close.c"
    click MLXWindow "https://github.com/s-ike/cub3d/blob/master/srcs/exit.c"
    click MLXWindow "https://github.com/s-ike/cub3d/blob/master/srcs/exit_sub.c"
    click MLXWindow "https://github.com/s-ike/cub3d/blob/master/includes/struct_mlximg.h"
    click MLXWindow "https://github.com/s-ike/cub3d/blob/master/includes/struct_screen.h"
    click libft "https://github.com/s-ike/cub3d/tree/master/libft/"
    click utils "https://github.com/s-ike/cub3d/blob/master/srcs/utils/get_line.c"
    click utils "https://github.com/s-ike/cub3d/blob/master/srcs/utils/bitmap.c"
    click utils "https://github.com/s-ike/cub3d/blob/master/srcs/utils/util.c"
    click utils "https://github.com/s-ike/cub3d/blob/master/includes/utils.h"
    click TestMaps "https://github.com/s-ike/cub3d/tree/master/test/"
    click Headers "https://github.com/s-ike/cub3d/tree/master/includes/"
    click Bonus "https://github.com/s-ike/cub3d/tree/master/srcs_bonus/"
    click Bonus "https://github.com/s-ike/cub3d/tree/master/includes_bonus/"

    %% Styles
    classDef io fill:#cfe2f3,stroke:#6fa8dc,stroke-width:1px
    classDef core fill:#d9ead3,stroke:#6aa84f,stroke-width:1px
    classDef lib fill:#f9cb9c,stroke:#e69138,stroke-width:1px
    classDef external fill:#ffe599,stroke:#f1c232,stroke-width:1px
    classDef assets fill:#e7e6e6,stroke:#a6a6a6,stroke-width:1px
```
