# lukesmithxyz/voidrice architecture

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

- Interactive diagram: https://gitdiagram.com/lukesmithxyz/voidrice
- Repository: https://github.com/lukesmithxyz/voidrice

## Overview

##### Main Components

a. Configuration Management Layer
- Core configuration files (.config directory)
- User-specific settings (.local directory)
- Shell environment configurations

b. Script Management Layer
- Executable scripts (.local/bin)
- Status bar scripts (statusbar directory)
- System utilities

c. Application Configurations
- Text editors (nvim)
- Media players (mpv, mpd)
- File managers (lf)
- Shell (zsh)

**┌─────────────────────────────────────────────┐**
- User Interface Layer           │
- (dwm, st, dwmblocks - external deps)      │
- ┤
- Configuration Management            │
- ┬─────────────┬──────────────┤
- Core Config  │ User Config │ Shell Config │
- (~/.config)  │  (~/.local) │ (zsh/shell)  │
- ┴─────────────┴──────────────┤
- Script Management               │
- ┬─────────────────────┤
- System Scripts    │   Status Scripts    │
- (.local/bin)      │   (statusbar/*)    │
- ┴─────────────────────┤
- Application Configurations        │
- ┘

##### Key Relationships to Highlight

- How shell configurations (.zshrc, profile) interact with other components
- Relationship between status bar scripts and dwmblocks
- Demonstrate how application configs are linked to their respective programs
- Connection between bookmarks and the shortcuts system

##### Implementation Details

- Annotations for important scripts like shortcuts, remaps, and statusbar
- Relationship between templates (wal/templates) and generated configs
- How the system handles different types of media (mimeapps.list)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        UI_DWM[DWM Window Manager]
        UI_ST[ST Terminal]
        UI_BLOCKS[DWMBlocks Status Bar]
    end

    subgraph "Configuration Management"
        direction TB
        CORE["Core Configuration"]:::core
        USER["User Configuration"]:::user
        SHELL["Shell Configuration"]:::shell
        X11["X11 Configuration"]:::x11
        MIME["MIME Applications"]:::mime
        TEMPLATES["Template System"]:::templates
    end

    subgraph "Script Management"
        direction TB
        SYS_SCRIPTS["System Scripts"]:::scripts
        STATUS_SCRIPTS["Status Bar Scripts"]:::status
        CRON["Cron Jobs"]:::cron
    end

    subgraph "Application Configurations"
        direction TB
        NVIM["Neovim Editor"]:::app
        MPV["MPV Player"]:::app
        MPD["MPD Music Player"]:::app
        LF["LF File Manager"]:::app
        ZSH["ZSH Shell"]:::app
    end

    subgraph "Resource Management"
        direction TB
        SHORTCUTS["Application Shortcuts"]:::res
        BOOKMARKS["System Bookmarks"]:::res
        CHARS["Character Resources"]:::res
        KEY_DOCS["Keyboard Shortcuts Docs"]:::res
    end

    %% Relationships
    UI_BLOCKS --> STATUS_SCRIPTS
    SHELL --> ZSH
    CORE --> X11
    CORE --> MIME
    CORE --> TEMPLATES
    USER --> SYS_SCRIPTS
    USER --> SHORTCUTS
    SYS_SCRIPTS --> STATUS_SCRIPTS
    SYS_SCRIPTS --> CRON
    BOOKMARKS --> LF
    TEMPLATES --> UI_BLOCKS

    %% Click Events
    click CORE "https://github.com/lukesmithxyz/voidrice/blob/master//.config"
    click USER "https://github.com/lukesmithxyz/voidrice/blob/master//.local"
    click SHELL "https://github.com/lukesmithxyz/voidrice/tree/master//.config/shell"
    click SYS_SCRIPTS "https://github.com/lukesmithxyz/voidrice/tree/master//.local/bin"
    click STATUS_SCRIPTS "https://github.com/lukesmithxyz/voidrice/tree/master//.local/bin/statusbar"
    click NVIM "https://github.com/lukesmithxyz/voidrice/tree/master//.config/nvim"
    click MPV "https://github.com/lukesmithxyz/voidrice/tree/master//.config/mpv"
    click MPD "https://github.com/lukesmithxyz/voidrice/tree/master//.config/mpd"
    click LF "https://github.com/lukesmithxyz/voidrice/tree/master//.config/lf"
    click ZSH "https://github.com/lukesmithxyz/voidrice/tree/master//.config/zsh"
    click X11 "https://github.com/lukesmithxyz/voidrice/tree/master//.config/x11"
    click SHORTCUTS "https://github.com/lukesmithxyz/voidrice/tree/master//.local/share/applications"
    click TEMPLATES "https://github.com/lukesmithxyz/voidrice/tree/master//.config/wal/templates"
    click BOOKMARKS "https://github.com/lukesmithxyz/voidrice/tree/master//.config/shell/bm-dirs"
    click MIME "https://github.com/lukesmithxyz/voidrice/blob/master//.config/mimeapps.list"
    click CRON "https://github.com/lukesmithxyz/voidrice/tree/master//.local/bin/cron"
    click CHARS "https://github.com/lukesmithxyz/voidrice/tree/master//.local/share/larbs/chars"
    click KEY_DOCS "https://github.com/lukesmithxyz/voidrice/tree/master//.local/share/larbs/getkeys"

    %% Styling
    classDef core fill:#2b6cb0,stroke:#1a4971,color:white
    classDef user fill:#38a169,stroke:#2f855a,color:white
    classDef shell fill:#805ad5,stroke:#6b46c1,color:white
    classDef scripts fill:#38a169,stroke:#2f855a,color:white
    classDef status fill:#4299e1,stroke:#3182ce,color:white
    classDef app fill:#ed8936,stroke:#dd6b20,color:white
    classDef res fill:#667eea,stroke:#5a67d8,color:white
    classDef x11 fill:#2b6cb0,stroke:#1a4971,color:white
    classDef mime fill:#2b6cb0,stroke:#1a4971,color:white
    classDef templates fill:#2b6cb0,stroke:#1a4971,color:white
    classDef cron fill:#38a169,stroke:#2f855a,color:white
```
