# bloodbat/sanguinemonsters architecture

> Architecture diagram of the GitHub repository bloodbat/sanguinemonsters, 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/bloodbat/sanguinemonsters
- Repository: https://github.com/bloodbat/sanguinemonsters

## Overview

##### Main Components

a) Core Framework Layer:
- Plugin initialization and registration system (plugin.cpp/hpp)
- Common utilities and helpers (sanguinehelpers.cpp/hpp)
- DSP components (sanguinedsp.hpp)
- UI components (sanguinecomponents.cpp/hpp)

b) Module Layer:
Modules into functional categories:
- Signal Generation (Bukavac, Raiju)
- Signal Processing (Werewolf, Alchemist)
- Control/Sequencing (Sphinx, Aion)
- Utility (Oubliette, Dolly-X, Medusa)
- Recording/Playback (Brainz)

c) External Dependencies:
- PCG Random Number Generation (pcg directory)
- Resource Management (res directory)

**[Resource Layer]**

**[Core Framework Layer]**

**[Module Layer]**

##### Key Relationships to Highlight

- How each module inherits from the core plugin framework
- Demonstrate shared resource usage (fonts, sequences)
- Common utility usage across modules
- PCG random number generator integration

##### Implementation Details

a) Core Infrastructure:
- [Plugin Registration] <- [Module Initialization]
- [Common Components] <- [DSP Utilities]
- [UI Components] <- [Resource Management]

b) Module Categories:
- [Signal Generators]
- Bukavac (Noise)
- Raiju (Fixed Voltage)

- [Processors]
- Werewolf (Distortion)
- Alchemist (Mixer)

- [Control]
- Sphinx (Sequencer)
- Aion (Timer)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Define styles
    classDef core fill:#9370DB,stroke:#333,stroke-width:2px
    classDef signal fill:#4682B4,stroke:#333,stroke-width:2px
    classDef process fill:#3CB371,stroke:#333,stroke-width:2px
    classDef control fill:#DAA520,stroke:#333,stroke-width:2px
    classDef utility fill:#808080,stroke:#333,stroke-width:2px
    classDef resource fill:#8B4513,stroke:#333,stroke-width:2px
    classDef external fill:#4169E1,stroke:#333,stroke-width:2px

    %% Resource Layer
    subgraph ResourceLayer
        PCG[("PCG Random Gen")]:::external
        Resources[("Resource Files")]:::resource
    end

    %% Core Framework Layer
    subgraph CoreFramework
        Plugin["Plugin System"]:::core
        UIComp["UI Components"]:::core
        DSPUtils["DSP Utilities"]:::core
        CommonUtils["Common Utilities"]:::core
        SeqComp["Sequencing Components"]:::core
        ThemeMan["Theme Management"]:::core
    end

    %% Module Layer
    subgraph SignalGen["Signal Generation"]
        Bukavac["Bukavac (Noise)"]:::signal
        Raiju["Raiju (Fixed Voltage)"]:::signal
    end

    subgraph SignalProc["Signal Processing"]
        Werewolf["Werewolf (Distortion)"]:::process
        Alchemist["Alchemist (Mixer)"]:::process
    end

    subgraph Control["Control/Sequencing"]
        Sphinx["Sphinx (Sequencer)"]:::control
        Aion["Aion (Timer)"]:::control
    end

    subgraph Utility["Utility Modules"]
        Oubliette["Oubliette"]:::utility
        DollyX["Dolly-X"]:::utility
        Medusa["Medusa"]:::utility
    end

    %% Relationships
    Plugin --> UIComp
    Plugin --> DSPUtils
    Plugin --> CommonUtils
    Plugin --> SeqComp
    Plugin --> ThemeMan

    PCG --> CommonUtils
    Resources --> UIComp
    Resources --> ThemeMan

    UIComp --> SignalGen
    UIComp --> SignalProc
    UIComp --> Control
    UIComp --> Utility

    DSPUtils --> SignalGen
    DSPUtils --> SignalProc
    DSPUtils --> Control

    CommonUtils --> SignalGen
    CommonUtils --> SignalProc
    CommonUtils --> Control
    CommonUtils --> Utility

    %% Click events for component mapping
    click Plugin "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/plugin.cpp"
    click UIComp "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/sanguinecomponents.cpp"
    click DSPUtils "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/sanguinedsp.hpp"
    click CommonUtils "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/sanguinehelpers.cpp"
    click PCG "https://github.com/Bloodbat/SanguineMonsters/blob/main/pcg/pcg_variants.h"
    click Resources "https://github.com/Bloodbat/SanguineMonsters/tree/main/res/components/"
    click Bukavac "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/bukavac.cpp"
    click Raiju "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/raiju.cpp"
    click Werewolf "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/werewolf.cpp"
    click Alchemist "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/alchemist.cpp"
    click Sphinx "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/sphinx.cpp"
    click Aion "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/aion.cpp"
    click Oubliette "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/oubliette.cpp"
    click DollyX "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/dollyx.cpp"
    click Medusa "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/medusa.cpp"
    click SeqComp "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/seqcomponents.hpp"
    click ThemeMan "https://github.com/Bloodbat/SanguineMonsters/blob/main/src/themes.cpp"

    %% Legend
    subgraph Legend
        L1["Core Framework"]:::core
        L2["Signal Generation"]:::signal
        L3["Signal Processing"]:::process
        L4["Control/Sequencing"]:::control
        L5["Utility"]:::utility
        L6["Resources"]:::resource
        L7["External"]:::external
    end
```
