# mcpar-land/bevy_fly_camera architecture

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

- Interactive diagram: https://gitdiagram.com/mcpar-land/bevy_fly_camera
- Repository: https://github.com/mcpar-land/bevy_fly_camera

## Overview

##### Main Components
- Bevy App
- DefaultPlugins (Bevy-provided core systems: rendering, input, ECS scheduler)
- FlyCameraPlugin (the plugin provided by this crate)
- User Startup System (e.g., setup() in examples)
- FlyCameraPlugin
- 2D Camera System (from src/cam2d.rs)
- 3D Camera System (from src/lib.rs / cam3d.rs)
- Utility Module (src/util.rs, e.g., input mappings, sensitivity)
- Entities & Components
- Camera Entity (Camera2dBundle or Camera3dBundle)
- FlyCamera2d or FlyCamera component (data: speed, keybinds)
- Transform component (from Bevy)
- External Services/Dependencies
- Bevy Engine (input, time, ECS)

##### Relationships and Data Flow
- App Initialization
→ Add DefaultPlugins
→ Add FlyCameraPlugin
→ Run startup system (spawns camera entity + attaches FlyCamera component)
- Runtime Loop (per frame):
Input Events → FlyCameraPlugin systems → Read FlyCamera & Transform components → Update Transform → Rendering pipeline
- Utility functions sit alongside systems to interpret raw input (keyboard/mouse) into movement vectors.

##### Architectural Patterns & Principles
- ECS (Entity‑Component‑System) pattern:
- Components: FlyCamera, Transform
- Systems: camera_move_2d, camera_move_3d, mouse_look_3d
- Plugin pattern (Bevy’s extension mechanism): registers its systems into Bevy’s scheduler
- Single Responsibility: cam2d.rs handles 2D movement, cam3d.rs handles 3D movement plus mouse, util.rs handles shared math/config

##### Technologies & Frameworks
- Rust (language)
- Bevy (game engine; ECS, rendering, input)
- bevy_fly_camera (this crate)
- No external services beyond local input/mouse/time

##### Final Checklist
- [ ] Clear labels for App modules, Plugin, Systems, Entities, Components
- [ ] Indication of file-to-system mapping (cam2d.rs, cam3d.rs, util.rs)
- [ ] Note default keybind values on the FlyCamera component

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Inputs and Outputs
    Input["Keyboard/Mouse Input"]:::external
    Rendering["Rendering Pipeline"]:::external

    %% Bevy Application
    subgraph "Bevy App"
        direction TB
        DefaultPlugins["DefaultPlugins"]:::bevy
        FlyCameraPlugin["FlyCameraPlugin"]:::plugin
        subgraph "User Startup Systems"
            direction TB
            Setup3D["setup() (3D)"]:::user
            Setup2D["setup() (2D)"]:::user
        end
    end

    %% Plugin Internals
    subgraph "FlyCameraPlugin Internals"
        direction TB
        Cam2D["camera_move_2d() / FlyCamera2d"]:::plugin
        Cam3D["camera_move_3d() & mouse_look() / FlyCamera"]:::plugin
        Util["Utility Module"]:::plugin
    end

    %% Entities & Components
    subgraph "Entities & Components"
        direction TB
        Camera3D["Camera3dBundle + FlyCamera"]:::entity
        Camera2D["Camera2dBundle + FlyCamera2d"]:::entity
        Transform["Transform Component"]:::entity
    end

    %% Relationships / Data Flow
    Input -->|feeds| Cam2D
    Input -->|feeds| Cam3D
    Cam2D -->|updates| Transform
    Cam3D -->|updates| Transform
    Transform -->|drives| Rendering

    %% App Initialization Flow
    DefaultPlugins -->|added to App| FlyCameraPlugin
    FlyCameraPlugin -->|registers systems| Cam2D
    FlyCameraPlugin -->|registers systems| Cam3D
    FlyCameraPlugin -->|uses| Util
    Setup3D -->|spawns| Camera3D
    Setup2D -->|spawns| Camera2D
    Camera3D -->|has| Transform
    Camera2D -->|has| Transform

    %% Click Events
    click DefaultPlugins "https://github.com/mcpar-land/bevy_fly_camera/blob/master/examples/basic.rs"
    click DefaultPlugins "https://github.com/mcpar-land/bevy_fly_camera/blob/master/examples/2d.rs"
    click FlyCameraPlugin "https://github.com/mcpar-land/bevy_fly_camera/blob/master/src/lib.rs"
    click Setup3D "https://github.com/mcpar-land/bevy_fly_camera/blob/master/examples/basic.rs"
    click Setup2D "https://github.com/mcpar-land/bevy_fly_camera/blob/master/examples/2d.rs"
    click Cam2D "https://github.com/mcpar-land/bevy_fly_camera/blob/master/src/cam2d.rs"
    click Cam3D "https://github.com/mcpar-land/bevy_fly_camera/blob/master/src/lib.rs"
    click Util "https://github.com/mcpar-land/bevy_fly_camera/blob/master/src/util.rs"
    click Camera3D "https://github.com/mcpar-land/bevy_fly_camera/blob/master/examples/basic.rs"
    click Camera2D "https://github.com/mcpar-land/bevy_fly_camera/blob/master/examples/2d.rs"

    %% Styles
    classDef bevy fill:#D0E6FF,stroke:#0366D6,color:#0366D6
    classDef plugin fill:#DFF2BF,stroke:#4F8A10,color:#4F8A10
    classDef entity fill:#FFE6CC,stroke:#E68A00,color:#E68A00
    classDef user fill:#F0F0F0,stroke:#999,color:#333
    classDef external fill:#EFEFEF,stroke:#666,color:#666
```
