# vitovan/calm architecture

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

## Overview

##### Main Components Identification

a) Core Components:
- Cairo Graphics Engine Integration
- SDL2 Window Management
- Common Lisp Runtime
- Web Assembly Bridge (for web deployment)
- Audio System
- Event System

b) Build/Distribution Systems:
- Linux AppImage Builder
- macOS Bundle/DMG Creator
- Windows Installer Generator
- Web Publisher

- Application Layer                                       |

- User Canvas   |  |    Assets     |  |     Fonts     |  |    Sound       |          |
- (canvas.lisp) |  |  Directory    |  |   Directory   |  |    Files      |          |

- CALM Core Layer                                      |

- Cairo Drawing |  |  SDL2 Window   |  |  Event System  |  |  Audio System  |          |
- Engine      |  |   Management   |  |   Handling     |  |   Playback     |          |

- Platform-Specific Layer                                    |

- Native     |  |     Native     |  |     Native     |  |      Web       |          |
- Linux Build   |  |  macOS Build   |  | Windows Build  |  |    Assembly    |          |

##### Connection Types

- Double lines: Data flow

##### Implementation Details

- The event-driven architecture
- The canvas rendering pipeline
- The build/publish workflow
- Platform-specific packaging processes

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Application Layer"
        Canvas["User Canvas"]:::userCanvas
        Assets["Assets Directory"]:::assets
        Fonts["Fonts Directory"]:::fonts
        Sound["Sound Files"]:::sound
    end

    subgraph "CALM Core Layer"
        Cairo["Cairo Drawing Engine"]:::core
        SDL["SDL2 Window Management"]:::core
        Events["Event System"]:::core
        Audio["Audio System"]:::core
        Config["Configuration System"]:::core
        FontMgmt["Font Management"]:::core
        Package["Package System"]:::core
        Core["Core System"]:::core
    end

    subgraph "Platform-Specific Layer"
        Linux["Native Linux Build"]:::platform
        MacOS["Native macOS Build"]:::platform
        Windows["Native Windows Build"]:::platform
        Web["Web Assembly"]:::platform
    end

    subgraph "Build Systems"
        LinuxBuilder["Linux AppImage Builder"]:::build
        MacBuilder["macOS Bundle/DMG Creator"]:::build
        WinBuilder["Windows Installer Generator"]:::build
        WebBuilder["Web Publisher"]:::build
    end

    subgraph "Examples"
        CanvasExamples["Canvas Examples"]:::example
        AudioExample["Audio Example"]:::example
    end

    %% Core Dependencies
    Canvas --> Core
    Core --> Cairo
    Core --> SDL
    Core --> Events
    Core --> Audio
    Core --> Config
    Core --> FontMgmt
    Core --> Package

    %% Asset Dependencies
    Canvas --> Assets
    Canvas --> Fonts
    Canvas --> Sound

    %% Build System Flow
    Linux --> LinuxBuilder
    MacOS --> MacBuilder
    Windows --> WinBuilder
    Web --> WebBuilder

    %% Example Dependencies
    CanvasExamples --> Canvas
    AudioExample --> Audio

    %% Platform-specific build scripts
    LinuxBuilder --> LinuxScripts["Linux Build Scripts"]:::script
    MacBuilder --> MacScripts["macOS Build Scripts"]:::script
    WinBuilder --> WinScripts["Windows Build Scripts"]:::script

    %% Web Assembly Bridge
    Web --> WebBridge["Web Assembly Bridge"]:::bridge

    %% Style Definitions
    classDef core fill:#a8d5ff
    classDef assets fill:#98ff98
    classDef platform fill:#dda0dd
    classDef build fill:#ffa500
    classDef example fill:#f0e68c
    classDef script fill:#d3d3d3
    classDef bridge fill:#ff9999
    classDef userCanvas fill:#90ee90
    classDef fonts fill:#98fb98
    classDef sound fill:#98ff98

    %% Click Events
    click Cairo "https://github.com/VitoVan/calm/blob/main/src/cairo.lisp"
    click Events "https://github.com/VitoVan/calm/blob/main/src/events.lisp"
    click WebBridge "https://github.com/VitoVan/calm/blob/main/src/web/bridge.js"
    click Core "https://github.com/VitoVan/calm/blob/main/src/calm.lisp"
    click Config "https://github.com/VitoVan/calm/blob/main/src/config.lisp"
    click FontMgmt "https://github.com/VitoVan/calm/blob/main/src/fontconfig.lisp"
    click Package "https://github.com/VitoVan/calm/blob/main/src/package.lisp"
    click LinuxBuilder "https://github.com/VitoVan/calm/blob/main/s/usr/linux/appimage.lisp"
    click MacBuilder "https://github.com/VitoVan/calm/blob/main/s/usr/macos/bundle.lisp"
    click WinBuilder "https://github.com/VitoVan/calm/blob/main/s/usr/windows/installer.lisp"
    click WebBuilder "https://github.com/VitoVan/calm/blob/main/s/usr/web/wasm.lisp"
    click CanvasExamples "https://github.com/VitoVan/calm/blob/main/docs/examples/circles/canvas.lisp"
    click AudioExample "https://github.com/VitoVan/calm/blob/main/docs/examples/meditator/canvas.lisp"
    click LinuxScripts "https://github.com/VitoVan/calm/tree/main/s/dev/fedora"
    click MacScripts "https://github.com/VitoVan/calm/tree/main/s/dev/darwin"
    click WinScripts "https://github.com/VitoVan/calm/tree/main/s/dev/msys"
```
