# saidyanak/so_long architecture

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

- Interactive diagram: https://gitdiagram.com/saidyanak/so_long
- Repository: https://github.com/saidyanak/so_long

## Overview

##### Project type and purpose
- This is a small 2D “so_long” maze‐style game written in C, using MiniLibX for graphics and a custom libft for utility functions.
- Its purpose is to load a map from a “.ber” file, validate it, render it in a window, handle user input, update game state, and exit when the player collects items and reaches the exit.

##### File structure
Top‐level C modules:
- so_long.c           – program entry point, initializes everything, enters game loop
- init_map.c / read_map.c / map_checker.c / map_reachable.c – load, parse, and validate the map
- render_map.c        – translate the in‐memory map into on‐screen pixels
- accessibility_controls.c – user input handler (keyboard controls)
- close_window.c      – window/event teardown
- get_next_line.c     – line‐by‐line file reader
Assets:
- images/*.xpm        – tile assets (walls, player, collectibles, exit, background)
- maps/*.ber          – sample maps
Third‐party libraries:
- libs/libft          – standard C helpers (strings, memory, I/O)
- libs/minilibx-linux – graphical/context hooks to X11
Build & config:
- Makefile
- .vscode (editor settings)

##### Missing README
– No architecture sketch exists, so we’ll infer from code organization.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% File I/O & Map Module
    subgraph "File I/O & Map Module"
        read_map["read_map.c"]:::io
        get_next_line["get_next_line.c"]:::io
        init_map["init_map.c"]:::io
        map_checker["map_checker.c"]:::io
        map_reachable["map_reachable.c"]:::io
        MapData["Validated Map"]:::io
    end

    %% Game Core
    subgraph "Game Core"
        so_long["so_long.c (Main Loop)"]:::core
        so_long_h["so_long.h"]:::core
    end

    %% Input Module
    subgraph "Input Module"
        accessibility["accessibility_controls.c"]:::core
    end

    %% Rendering Module
    subgraph "Rendering Module"
        AssetManager["Asset Manager"]:::io
        render_map["render_map.c"]:::core
        bg["background.xpm"]:::asset
        collect["collectibe.xpm"]:::asset
        exitAsset["exit.xpm"]:::asset
        player["player.xpm"]:::asset
        wall["wall.xpm"]:::asset
    end

    %% Window & OS Interface
    subgraph "Window & OS Interface"
        mini["libs/minilibx-linux/"]:::external
        close["close_window.c"]:::core
        OSWindow["OS Window"]:::external
    end

    %% Utility Library
    libft["libs/libft/"]:::external

    %% Sample Maps
    maps["maps/a.ber"]:::asset

    %% Data Flows
    maps -->|"RawMapFile"| read_map
    get_next_line -->|"Lines"| read_map
    read_map -->|"RawData"| init_map
    init_map -->|"MapInit"| map_checker
    map_checker -->|"CheckedMap"| map_reachable
    map_reachable -->|"ReachableMap"| MapData
    MapData -->|"ParsedMap"| so_long
    so_long_h --> so_long

    accessibility -->|"KeyEvent"| so_long

    so_long -->|"InitAssets"| AssetManager
    AssetManager --> bg
    AssetManager --> collect
    AssetManager --> exitAsset
    AssetManager --> player
    AssetManager --> wall

    so_long -->|"FrameEvent"| render_map
    render_map -->|"DrawCalls"| mini
    mini -->|"X11Window"| OSWindow

    accessibility --> mini
    close --> mini
    so_long --> close

    %% Utility usage
    libft -.-> read_map
    libft -.-> get_next_line
    libft -.-> init_map
    libft -.-> map_checker
    libft -.-> map_reachable

    %% Click Events
    click read_map "https://github.com/saidyanak/so_long/blob/main/read_map.c"
    click get_next_line "https://github.com/saidyanak/so_long/blob/main/get_next_line.c"
    click init_map "https://github.com/saidyanak/so_long/blob/main/init_map.c"
    click map_checker "https://github.com/saidyanak/so_long/blob/main/map_checker.c"
    click map_reachable "https://github.com/saidyanak/so_long/blob/main/map_reachable.c"
    click so_long "https://github.com/saidyanak/so_long/blob/main/so_long.c"
    click so_long_h "https://github.com/saidyanak/so_long/blob/main/so_long.h"
    click accessibility "https://github.com/saidyanak/so_long/blob/main/accessibility_controls.c"
    click render_map "https://github.com/saidyanak/so_long/blob/main/render_map.c"
    click close "https://github.com/saidyanak/so_long/blob/main/close_window.c"
    click mini "https://github.com/saidyanak/so_long/tree/main/libs/minilibx-linux/"
    click libft "https://github.com/saidyanak/so_long/tree/main/libs/libft/"
    click bg "https://github.com/saidyanak/so_long/blob/main/images/background.xpm"
    click collect "https://github.com/saidyanak/so_long/blob/main/images/collectibe.xpm"
    click exitAsset "https://github.com/saidyanak/so_long/blob/main/images/exit.xpm"
    click player "https://github.com/saidyanak/so_long/blob/main/images/player.xpm"
    click wall "https://github.com/saidyanak/so_long/blob/main/images/wall.xpm"
    click maps "https://github.com/saidyanak/so_long/blob/main/maps/a.ber"

    %% Styles
    classDef core fill:#D0E6F8,stroke:#0366d6,stroke-width:2px
    classDef io fill:#DFF2BF,stroke:#4F8A10,stroke-width:2px
    classDef external fill:#FFD2D2,stroke:#D8000C,stroke-width:2px
    classDef asset fill:#F3D1FF,stroke:#B633D8,stroke-width:2px
```
