# mylinuxforwork/hyprland-starter architecture

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

- Interactive diagram: https://gitdiagram.com/mylinuxforwork/hyprland-starter
- Repository: https://github.com/mylinuxforwork/hyprland-starter

## Overview

##### Project type and purpose
- This is a “dotfiles” / configuration‐as‐code project that provides a ready‐made Hyprland desktop environment.
- Purpose: automate installation of dependencies, deploy a curated set of Hyprland + related tool configurations, and bootstrap a consistent user environment across Linux distros.

##### File structure
Top level
- hyprland‐starter.dotinst — descriptor for the external Dotfiles Installer
- setup‐*.sh, sync.sh — distro‐specific and general installer/synchronization scripts
- dotfiles/ — all user configs and helper scripts
Under dotfiles/
- .bashrc — shell initialization
- .config/
– hypr/ (hyprland.conf + modular conf/*.conf)
– waybar/ (bar config, modules, style)
– rofi/ (launcher config)
– dunst/ (notification config)
– wlogout/ (lock/logout UI)
– ml4w/ (helper AppImage, scripts, settings overrides)
– other app configs (alacritty, Thunar, etc.)

##### README
- Describes installation via Dotfiles Installer + setup scripts
- Lists required packages (Hyprland, Waybar, Rofi, Alacritty, Dunst, Thunar, hyprpaper, hyprlock, Firefox, etc.)
- Points out keybindings and where they live in the config.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Deployment Phase
    subgraph "Deployment Phase"
        direction TB
        User["User Machine"]:::external
        DotInstaller["Dotfiles Installer"]:::deployment
        Descriptor["hyprland-starter.dotinst"]:::deployment
        subgraph "Setup Scripts"
            direction TB
            SetupGeneral["setup.sh"]:::deployment
            SetupArch["setup-arch.sh"]:::deployment
            SetupFedora["setup-fedora.sh"]:::deployment
            SetupOpenSUSE["setup-opensuse.sh"]:::deployment
            SetupDeps["setup-dependencies.sh"]:::deployment
            Sync["sync.sh"]:::deployment
        end
        OSPkg["OS Package Manager"]:::deployment
        GitRepo["Git Repo"]:::repo
        Dotfiles["dotfiles/"]:::config
        Bashrc[".bashrc"]:::config
        subgraph "Configs (~/.config)"
            direction TB
            HyprConfig["hyprland.conf"]:::config
            HyprMods["conf/*.conf"]:::config
            HyprLock["hyprlock.conf"]:::config
            HyprPaper["hyprpaper.conf"]:::config
            WaybarConfig["waybar/config"]:::config
            WaybarMods["waybar/modules.json"]:::config
            WaybarStyle["waybar/style.css"]:::config
            RofiConfig["rofi/config.rasi"]:::config
            DunstConfig["dunst/dunstrc"]:::config
            WLogout["wlogout/"]:::config
            ML4W["ml4w/"]:::config
            AlacrittyConfig["alacritty/alacritty.toml"]:::config
        end
    end

    %% Runtime Phase
    subgraph "Runtime Phase"
        direction TB
        Hyprland["Hyprland"]:::runtime
        Waybar["Waybar"]:::runtime
        Rofi["Rofi-Wayland"]:::runtime
        Alacritty["Alacritty"]:::runtime
        Dunst["Dunst"]:::runtime
        Thunar["Thunar"]:::runtime
        Hyprpaper["Hyprpaper"]:::runtime
        HyprlockSvc["Hyprlock"]:::runtime
        Firefox["Firefox"]:::runtime
    end

    %% Connections
    User -->|launches| DotInstaller
    DotInstaller -->|reads| Descriptor
    Descriptor -->|invokes| SetupGeneral
    Descriptor --> SetupArch
    Descriptor --> SetupFedora
    Descriptor --> SetupOpenSUSE
    SetupGeneral -->|optionally calls| SetupDeps
    SetupGeneral -->|optionally calls| Sync
    SetupGeneral -->|uses| OSPkg
    SetupArch --> OSPkg
    SetupFedora --> OSPkg
    SetupOpenSUSE --> OSPkg
    SetupGeneral -->|clones/copies| GitRepo
    GitRepo -->|contains| Dotfiles
    Dotfiles --> Bashrc
    Dotfiles --> HyprConfig
    HyprConfig --> HyprMods
    Dotfiles --> HyprLock
    Dotfiles --> HyprPaper
    Dotfiles --> WaybarConfig
    Dotfiles --> WaybarMods
    Dotfiles --> WaybarStyle
    Dotfiles --> RofiConfig
    Dotfiles --> DunstConfig
    Dotfiles --> WLogout
    Dotfiles --> ML4W
    Dotfiles --> AlacrittyConfig

    %% Runtime connections
    User -->|logs into| Hyprland
    Hyprland -->|reads| HyprConfig
    HyprConfig -->|includes| HyprMods
    Hyprland -->|spawns| Waybar
    Hyprland -->|spawns| Dunst
    Hyprland -->|spawns| Hyprpaper
    Hyprland -->|spawns| HyprlockSvc
    Hyprland -->|keybinds launch| Alacritty
    Hyprland -->|keybinds launch| Rofi
    Hyprland -->|keybinds launch| Thunar
    Hyprland -->|keybinds launch| Firefox

    %% Click Events
    click Descriptor "https://github.com/mylinuxforwork/hyprland-starter/blob/main/hyprland-starter.dotinst"
    click SetupGeneral "https://github.com/mylinuxforwork/hyprland-starter/blob/main/setup.sh"
    click SetupArch "https://github.com/mylinuxforwork/hyprland-starter/blob/main/setup-arch.sh"
    click SetupFedora "https://github.com/mylinuxforwork/hyprland-starter/blob/main/setup-fedora.sh"
    click SetupOpenSUSE "https://github.com/mylinuxforwork/hyprland-starter/blob/main/setup-opensuse.sh"
    click SetupDeps "https://github.com/mylinuxforwork/hyprland-starter/blob/main/setup-dependencies.sh"
    click Sync "https://github.com/mylinuxforwork/hyprland-starter/blob/main/sync.sh"
    click Dotfiles "https://github.com/mylinuxforwork/hyprland-starter/tree/main/dotfiles/"
    click Bashrc "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.bashrc"
    click AlacrittyConfig "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/alacritty/alacritty.toml"
    click HyprConfig "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/hypr/hyprland.conf"
    click HyprMods "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/hypr/conf/*.conf"
    click HyprLock "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/hypr/hyprlock.conf"
    click HyprPaper "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/hypr/hyprpaper.conf"
    click WaybarConfig "https://github.com/mylinuxforwork/hyprland-starter/tree/main/dotfiles/.config/waybar/config"
    click WaybarMods "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/waybar/modules.json"
    click WaybarStyle "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/waybar/style.css"
    click RofiConfig "https://github.com/mylinuxforwork/hyprland-starter/blob/main/dotfiles/.config/rofi/config.rasi"
    click DunstConfig "https://github.com/mylinuxforwork/hyprland-starter/tree/main/dotfiles/.config/dunst/dunstrc"
    click WLogout "https://github.com/mylinuxforwork/hyprland-starter/tree/main/dotfiles/.config/wlogout/"
    click ML4W "https://github.com/mylinuxforwork/hyprland-starter/tree/main/dotfiles/.config/ml4w/"

    %% Styles
    classDef external fill:#f0f0f0 stroke:#333;
    classDef deployment fill:#cce5ff stroke:#0366d6;
    classDef config fill:#fff3cd stroke:#856404;
    classDef runtime fill:#d4edda stroke:#155724;
    classDef repo fill:#e2e3e5 stroke:#6c757d;
```
