# grassmunk/chicago95 architecture

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

- Interactive diagram: https://gitdiagram.com/grassmunk/chicago95
- Repository: https://github.com/grassmunk/chicago95

## Overview

##### Project type and purpose
- Chicago95 is an open-source “total conversion” theme package and helper tool for Linux desktops (XFCE, GTK2/3, Cinnamon, Gnome-Shell, KDE SDDM, Lightdm, Plymouth).

##### File structure
- Cursors (multiple sub-themes with build scripts)
- Fonts (bitmap, VGA)
- Theme (GTK2, GTK3, Cinnamon, Gnome-Shell, XFWM4)
- Plymouth (boot splash)
- KDE (SDDM theme, splash screen)
- Lightdm (greeter HTML/CSS/JS)
- Sounds (audio theme)
- Extras (backgrounds, LibreOffice iconset, config snippets, helper scripts)
- Plus (Python tool: Plus.py, PlusGUI.py, pluslib.py)
- Build & installer scripts at root and in subfolders (Makefile, installer.py, Build.sh, cursors_gen.py, recolor.py) form the packaging layer.

##### README for architecture insights
- It lists included modules, dependencies (GTK engines, xfce4-panel-profiles, Python, bash), and usage scenarios.
- Emphasizes separation of asset domains and existence of an automated installer plus a GUI tool.

##### Main components & their relationships
- Asset Modules → Build & Packaging Layer → Installer/Makefile → System directories
- Chicago95 Plus! (UI) ←→ pluslib (core logic) invokes installer API and previews assets
- Desktop Environment Integration reads from installed asset directories:
- X server applies cursors
- GTK engines load theme CSS
- GNOME Shell reads SCSS/CSS assets
- Lightdm loads HTML/CSS/JS
- KDE SDDM uses QML/metadata
- Plymouth uses .plymouth and script

##### Architectural patterns & design principles
- Modular asset domains: each folder is a self-contained theme module
- Layered build pipeline: scripts transform raw assets into installable packages
- MVC-like separation in Plus!: PlusGUI (view) ↔ Plus.py/pluslib (controller/model)
- Extensibility via Extras folder for custom iconsets, backgrounds, configurations

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Asset Modules
    subgraph "Asset Modules"
        Cursors["Cursors Module"]:::cursors
        Icons["Icons Module"]:::icons
        Fonts["Fonts Module"]:::fonts
        Theme["Theme Module"]:::themes
        Plymouth["Plymouth Module"]:::plymouth
        KDE["KDE Module"]:::kde
        Lightdm["Lightdm Module"]:::lightdm
        Sounds["Sounds Module"]:::sounds
        Extras["Extras Module"]:::extras
    end

    %% Build & Packaging Layer
    subgraph "Build & Packaging Layer"
        Makefile["Makefile"]:::build
        InstallerScript["installer.py"]:::build
        BuildHelper["Build.sh (Cursors)"]:::build
        CursorGen["cursors_gen.py"]:::build
        Recolor["recolor.py"]:::build
    end

    %% Chicago95 Plus! Tool
    subgraph "Chicago95 Plus! Tool"
        PlusGUI["PlusGUI.py"]:::tool
        PlusCore["pluslib.py"]:::tool
        PlusCLI["ChicagoPlus.py"]:::tool
    end

    %% Installed Assets
    InstalledAssets["Installed Asset Directories"]:::installed

    %% Desktop Environments
    subgraph "Desktop Environments"
        XServer["X Server (Cursors)"]:::external
        GTK["GTK Engines (Themes)"]:::external
        GNOME["GNOME Shell (SCSS/CSS)"]:::external
        KDEDE["KDE SDDM (QML/metadata)"]:::external
        LightDMDE["Lightdm Greeter (HTML/CSS/JS)"]:::external
        PlyScript["Plymouth (Splash)"]:::external
    end

    %% Connections: Assets to Build
    Cursors -->|build scripts| BuildHelper
    Cursors -->|generate| CursorGen
    Icons -->|package| Makefile
    Fonts -->|package| Makefile
    Theme -->|package| Makefile
    Plymouth -->|package| Makefile
    KDE -->|package| Makefile
    Lightdm -->|package| Makefile
    Sounds -->|package| Makefile
    Extras -->|utilities| Recolor

    %% Build orchestration
    Makefile -->|invoke installer| InstallerScript
    InstallerScript -->|deploy| InstalledAssets

    %% Tool interactions
    PlusGUI -->|user actions| PlusCore
    PlusCLI -->|CLI commands| PlusCore
    PlusCore -->|install API| InstallerScript
    PlusCore -->|preview assets| InstalledAssets

    %% Installed Assets to DEs
    InstalledAssets -.->|load cursors| XServer
    InstalledAssets -.->|load themes| GTK
    InstalledAssets -.->|load SCSS/CSS| GNOME
    InstalledAssets -.->|load QML/metadata| KDEDE
    InstalledAssets -.->|load HTML/CSS/JS| LightDMDE
    InstalledAssets -.->|load boot theme| PlyScript

    %% Click Events
    click Cursors "https://github.com/grassmunk/chicago95/tree/master/Cursors/"
    click Icons "https://github.com/grassmunk/chicago95/tree/master/Icons/"
    click Fonts "https://github.com/grassmunk/chicago95/tree/master/Fonts/"
    click Theme "https://github.com/grassmunk/chicago95/tree/master/Theme/"
    click Plymouth "https://github.com/grassmunk/chicago95/tree/master/Plymouth/"
    click KDE "https://github.com/grassmunk/chicago95/tree/master/KDE/"
    click Lightdm "https://github.com/grassmunk/chicago95/tree/master/Lightdm/"
    click Sounds "https://github.com/grassmunk/chicago95/tree/master/sounds/"
    click Extras "https://github.com/grassmunk/chicago95/tree/master/Extras/"
    click PlusGUI "https://github.com/grassmunk/chicago95/blob/master/Plus/PlusGUI.py"
    click PlusCore "https://github.com/grassmunk/chicago95/blob/master/Plus/pluslib.py"
    click PlusCLI "https://github.com/grassmunk/chicago95/blob/master/Plus/ChicagoPlus.py"
    click Makefile "https://github.com/grassmunk/chicago95/tree/master/Makefile"
    click InstallerScript "https://github.com/grassmunk/chicago95/blob/master/installer.py"
    click BuildHelper "https://github.com/grassmunk/chicago95/blob/master/Cursors/Chicago95_Cursor_Black/src/Build.sh"
    click CursorGen "https://github.com/grassmunk/chicago95/blob/master/Cursors/Chicago95_Standard_Cursors/build/cursors_gen.py"
    click Recolor "https://github.com/grassmunk/chicago95/blob/master/Extras/recolor.py"

    %% Styles
    classDef cursors fill:#f5a623,stroke:#f08000,color:#000;
    classDef icons fill:#5dade2,stroke:#3498db,color:#000;
    classDef fonts fill:#48c9b0,stroke:#1abc9c,color:#000;
    classDef themes fill:#27ae60,stroke:#229954,color:#000;
    classDef plymouth fill:#d1f2eb,stroke:#76d7c4,color:#000;
    classDef kde fill:#9b59b6,stroke:#8e44ad,color:#fff;
    classDef lightdm fill:#f1948a,stroke:#e74c3c,color:#000;
    classDef sounds fill:#cd6155,stroke:#a93226,color:#fff;
    classDef extras fill:#a6acaf,stroke:#7f8c8d,color:#000;
    classDef build fill:#e74c3c,stroke:#c0392b,color:#fff;
    classDef tool fill:#8e44ad,stroke:#6c3483,color:#fff;
    classDef installed fill:#f0b27a,stroke:#d35400,color:#000;
    classDef external fill:#d5dbdb,stroke:#7f8c8d,color:#000;
```
