# marcboule/geodesics architecture

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

- Interactive diagram: https://gitdiagram.com/marcboule/geodesics
- Repository: https://github.com/marcboule/geodesics

## Overview

##### Main System Components

a) Core Framework Layer:
- Integration with VCV Rack platform
- Plugin registration system (plugin.json)

b) Module Layer:
Modules into functional categories:
- Signal Processing Modules (Black Holes, Energy, Dark Energy)
- Sequencer Modules (Ions, Entropia)
- Routing/Mixing Modules (Pulsars, Torus)
- Modulation Modules (Branes, Fate)

c) Resource Layer:
- Panel Themes (White Light and Dark Matter)
- Documentation Resources

##### Component Relationships

a) Plugin Integration:
**VCV Rack Platform → Plugin Registration → Module Implementation**

b) Module Implementation:
**Base Module Classes (GeoWidgets.hpp) → Individual Module Implementations**

c) Resource Usage:
**Theme Resources → Module UI**
**Documentation → Module Implementation**

##### Implementation Details

Key architectural patterns:

a) Module Architecture:
**GeoWidgets (Base Classes)**
- ↓
**Module Implementation (.cpp)**
- ↓
**Resource Integration (panels, assets)**

b) Resource Management:
**res/**
- DarkMatter Theme
- WhiteLight Theme

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Core Framework Layer"]
        VCV["VCV Rack Platform"]
        Plugin["Plugin Registration"]:::core
        GeoCore["Core Implementation"]:::core
        GeoBase["Base Module Classes"]:::core
    end

    subgraph Modules["Module Layer"]
        subgraph SignalProcessing["Signal Processing"]
            BH["Black Holes"]:::signal
            EN["Energy"]:::signal
            DE["Dark Energy"]:::signal
        end

        subgraph Sequencers["Sequencers"]
            IO["Ions"]:::seq
            ET["Entropia"]:::seq
        end

        subgraph Routing["Routing/Mixing"]
            PU["Pulsars"]:::routing
            TO["Torus"]:::routing
        end

        subgraph Modulation["Modulation"]
            BR["Branes"]:::mod
            FA["Fate"]:::mod
        end
    end

    subgraph Resources["Resource Layer"]
        Themes["Theme System"]
        DM["Dark Matter Theme"]:::theme
        WL["White Light Theme"]:::theme
        Doc["Documentation"]:::doc
    end

    %% Core Framework Relationships
    VCV --> Plugin
    Plugin --> GeoCore
    GeoCore --> GeoBase
    GeoBase --> SignalProcessing
    GeoBase --> Sequencers
    GeoBase --> Routing
    GeoBase --> Modulation

    %% Theme Relationships
    Themes --> DM
    Themes --> WL
    DM --> Modules
    WL --> Modules

    %% Documentation Links
    Doc --> SignalProcessing
    Doc --> Sequencers
    Doc --> Routing
    Doc --> Modulation

    %% Style Definitions
    classDef core fill:#3498db
    classDef signal fill:#2ecc71
    classDef seq fill:#e67e22
    classDef routing fill:#9b59b6
    classDef mod fill:#e74c3c
    classDef theme fill:#95a5a6
    classDef doc fill:#7f8c8d

    %% Click Events
    click Plugin "https://github.com/MarcBoule/Geodesics/blob/master/plugin.json"
    click GeoCore "https://github.com/MarcBoule/Geodesics/blob/master/src/Geodesics.hpp"
    click GeoBase "https://github.com/MarcBoule/Geodesics/blob/master/src/GeoWidgets.hpp"
    click BH "https://github.com/MarcBoule/Geodesics/blob/master/src/BlackHoles.cpp"
    click EN "https://github.com/MarcBoule/Geodesics/blob/master/src/Energy.cpp"
    click DE "https://github.com/MarcBoule/Geodesics/blob/master/src/DarkEnergy.cpp"
    click IO "https://github.com/MarcBoule/Geodesics/blob/master/src/Ions.cpp"
    click ET "https://github.com/MarcBoule/Geodesics/blob/master/src/Entropia.cpp"
    click PU "https://github.com/MarcBoule/Geodesics/blob/master/src/Pulsars.cpp"
    click TO "https://github.com/MarcBoule/Geodesics/blob/master/src/Torus.cpp"
    click BR "https://github.com/MarcBoule/Geodesics/blob/master/src/Branes.cpp"
    click FA "https://github.com/MarcBoule/Geodesics/blob/master/src/Fate.cpp"
    click DM "https://github.com/MarcBoule/Geodesics/tree/master/res/DarkMatter"
    click WL "https://github.com/MarcBoule/Geodesics/tree/master/res/WhiteLight"
    click Doc "https://github.com/MarcBoule/Geodesics/tree/master/doc"
```
