# skyler-ferrante/ncurses-pong architecture

> Architecture diagram of the GitHub repository skyler-ferrante/ncurses-pong, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/skyler-ferrante/ncurses-pong
- Repository: https://github.com/skyler-ferrante/ncurses-pong

## Overview

##### Main Components

a) Core Components:
- Input Handler (Terminal Input)
- Game Engine
- Renderer (ncurses)
- Game State Manager
- Game Loop Controller

b) Game Elements:
- Player Paddles
- Ball
- Score System
- Screen Boundaries

**[User Input] → [Input Handler] → [Game Loop Controller]**
- ↕
**[ncurses Library] ← [Renderer] ← [Game Engine] → [Game State Manager]**
- ↓
- [Game Objects (Ball/Paddles)]

##### Component Details

Input Handler:
- Terminal key capture
- Input processing for both players
- Practice mode input handling

Game Engine:
- Physics calculations
- Collision detection
- Score management
- Game rules implementation

Renderer:
- ncurses screen management
- Character-based graphics rendering
- Screen refresh logic

Game State Manager:
- Player positions
- Ball position and velocity
- Score tracking
- Game mode state (2-player vs practice)

##### Additional Elements

- Version information and build requirements
- Make/build process flow
- Configuration options (-p, -number arguments)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Component]:::component --- L2[Relationship]
        L3[External Library]:::external
        L4[Core Game Component]:::core
        L5[Input/Output]:::io
        L6[Game Objects]:::gameobj
    end

    subgraph "Terminal Interface"
        UserInput[User Input]:::io
        Terminal[Terminal Display]:::io
    end

    subgraph "Core System"
        InputHandler[Input Handler]:::core
        GameLoop[Game Loop Controller]:::core
        GameEngine[Game Engine]:::core
        Renderer[Renderer]:::core
        StateManager[Game State Manager]:::core
        
        click InputHandler "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
        click GameLoop "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
        click GameEngine "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
        click Renderer "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
        click StateManager "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
    end

    subgraph "Game Objects"
        Ball[Ball]:::gameobj
        Paddles[Paddles]:::gameobj
        Score[Score System]:::gameobj
        Boundaries[Screen Boundaries]:::gameobj

        click Ball "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
        click Paddles "https://github.com/skyler-ferrante/ncurses-pong/blob/master/pong.c"
    end

    subgraph "External Dependencies"
        Ncurses[ncurses Library]:::external
    end

    subgraph "Build System"
        Make[Makefile]:::component
        Docs[Documentation]:::component

        click Make "https://github.com/skyler-ferrante/ncurses-pong/tree/master/Makefile"
        click Docs "https://github.com/skyler-ferrante/ncurses-pong/blob/master/README.md"
    end

    UserInput --> InputHandler
    InputHandler --> GameLoop
    GameLoop --> GameEngine
    GameEngine --> StateManager
    GameEngine --> Renderer
    Renderer --> Terminal
    Renderer --> Ncurses
    
    GameEngine --> Ball
    GameEngine --> Paddles
    GameEngine --> Score
    GameEngine --> Boundaries

    classDef external fill:#6495ED,stroke:#333,stroke-width:2px
    classDef core fill:#90EE90,stroke:#333,stroke-width:2px
    classDef io fill:#FFD700,stroke:#333,stroke-width:2px
    classDef gameobj fill:#D3D3D3,stroke:#333,stroke-width:2px
    classDef component fill:#FFF,stroke:#333,stroke-width:2px
```
