bitzdots

gitlab
Lean Hyprland dotfiles with automatic matugen theming. Low-end optimized, full-stack auto-coloring, 26 Jinja2 templates. Rofi-powered menus, waybar modules, screenshot/recording, event-driven cache daemon.
0 stars0 forksupdated 2d agodefault branch: matugenExtended
Download .tar.gz View on gitlab ↗View on github ↗
clonehttps://gitlab.com/bitzzdev/bitzdots.git
archlinuxdotfileshyprlandhyprland-dotfileslow-endminimalricingwallustwaybarwayland
@ matugenExtended
9.9 KBtext
Raw View on gitlab ↗
1<div align="center">
2  <h1>bitzdots</h1>
3  <p><strong>Lean Hyprland dotfiles • Automatic matugen M3 theming • Low-end optimized</strong></p>
4 
5  <p>
6    <a href="#-features">Features</a> •
7    <a href="#-quick-start">Quick Start</a> •
8    <a href="docs/getting-started.md">Getting Started</a> •
9    <a href="docs/installation.md">Installation</a> •
10    <a href="docs/keybindings.md">Keybindings</a> •
11    <a href="docs/theming.md">Theming</a> •
12    <a href="docs/performance.md">Performance</a> •
13    <a href="docs/faq.md">FAQ</a>
14  </p>
15 
16  <p>
17    <img src="https://img.shields.io/badge/hyprland-latest-blue?style=flat-square" alt="Hyprland">
18    <img src="https://img.shields.io/badge/arch-supported-1793D1?style=flat-square&logo=archlinux" alt="Arch">
19    <img src="https://img.shields.io/badge/fedora-supported-294172?style=flat-square&logo=fedora" alt="Fedora">
20    <img src="https://img.shields.io/badge/debian-supported-A81D33?style=flat-square&logo=debian" alt="Debian">
21    <img src="https://img.shields.io/badge/nixos-supported-5277C3?style=flat-square&logo=nixos" alt="NixOS">
22    <img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="License">
23  </p>
24 
25  <p>
26    <a href="https://github.com/bitzzdev/bitzdots">
27      <img src="ss/ss3.png" alt="Screenshot 1" width="45%">
28    </a>
29    <a href="https://github.com/bitzzdev/bitzdots">
30      <img src="ss/ss2.png" alt="Screenshot 2" width="45%">
31    </a>
32    <a href="https://github.com/bitzzdev/bitzdots">
33      <img src="ss/ss1.png" alt="Screenshot 3" width="45%">
34    </a>
35    <a href="https://github.com/bitzzdev/bitzdots">
36      <img src="ss/ss4.png" alt="Screenshot 4" width="45%">
37    </a>
38  </p>
39</div>
40 
41---
42 
43> [!WARNING]
44> **Repository Renaming Notice:** This repository will be renamed to **DEVdots** soon.
45 
46bitzdots is a **lean, automated theming system** for Hyprland on Wayland. Change your wallpaper and every component, including the status bar, terminal, launcher, notifications, logout screen, audio visualizer, and Qt/KDE apps, adapts to match.
47 
48Built for **low-end hardware** without sacrificing usability. The full stack (Hyprland + waybar + swaync) idles under **300MB RAM**, with aggressive CPU optimizations to keep fans quiet on older machines.
49 
50## Features
51 
52- **Full-stack auto-theming:** One wallpaper change propagates to 20+ components via matugen M3 color extraction (waybar, kitty, rofi, swaync, wlogout, cava, Hyprland borders, Qt/KDE, GTK, and browser CSS).
53- **Event-driven cache daemon:** inotify-based background pre-generation keeps wallpaper switching fast.
54- **Live wallpaper support:** Static images with animated transitions (`awww`) and video wallpapers (`mpvpaper`) use automatic palette extraction.
55- **26 templates:** Every themed component, including launcher, power, wallpaper-grid themes, and eight SVG icons, uses a template.
56- **Rofi-powered menus:** The app launcher, clipboard manager (cliphist), power menu, wallpaper picker, WiFi, Bluetooth, audio, system monitor, and Quick Shelf styling are keyboard-navigable.
57- **Waybar with 16 modules:** Workspace display, CPU animation, media, Quick Shelf, recording indicator, brightness, power profiles, notifications, and system TUIs.
58- **Screen recording:** wf-recorder supports full-screen and region recording with audio and organized output directories.
59- **Screenshots with clipboard:** Fullscreen and selection screenshots both save and copy to the clipboard.
60- **Fish shell and fastfetch:** The shell stays quiet and fastfetch shows the custom BITZ logo on startup.
61- **Safe theme switching:** Every matugen run creates a backup and restores the previous theme if generation fails.
62- **Wallpaper cache daemon:** inotify watches wallpaper directories and pre-generates palettes.
63- **Multi-distro installer:** Automated setup supports Arch, Fedora, Debian/Ubuntu, and NixOS with `--with-deps`.
64 
65## Quick Start
66 
67```bash
68git clone https://github.com/bitzzdev/bitzdots.git ~/.config/bitzdots
69cd ~/.config/bitzdots
70chmod +x install.sh
71 
72# Link configs only:
73./install.sh
74 
75# Or link configs + install all system packages:
76./install.sh --with-deps
77```
78 
79See the **[Getting Started guide](docs/getting-started.md)** for a full walkthrough.
80 
81## Keybindings at a Glance
82 
83| Key | Action |
84|-----|--------|
85| `SUPER + T` | Open terminal |
86| `SUPER + Q` | Close window |
87| `SUPER + Space` | App launcher (rofi) |
88| `SUPER + V` | Clipboard history |
89| `SUPER + SHIFT + S` | Selection screenshot |
90| `Print` | Fullscreen screenshot |
91| `SUPER + R` | Toggle screen recording |
92| `SUPER + SHIFT + W` | Wallpaper picker |
93| `SUPER + N` | Toggle notifications |
94| `SUPER + P` | Power menu |
95| `SUPER + L` | Lock screen |
96 
97Full reference: **[docs/keybindings.md](docs/keybindings.md)**
98 
99## Documentation
100 
101| Guide | Description |
102|-------|------------|
103| [Getting Started](docs/getting-started.md) | First-time setup, recommended config |
104| [Installation](docs/installation.md) | Detailed install per distro, manual steps |
105| [Features](docs/features.md) | Complete feature breakdown |
106| [Keybindings](docs/keybindings.md) | All keyboard shortcuts |
107| [Waybar Modules](docs/waybar-modules.md) | Every module explained |
108| [Theming](docs/theming.md) | How matugen works, templates |
109| [Scripts](docs/scripts.md) | All utility scripts documented |
110| [Performance](docs/performance.md) | Low-end optimization guide |
111| [Customization](docs/customization.md) | Add new components, modify themes |
112| [DEVos Aliases](docs/devos-aliases.md) | Arch Linux `dev` shortcuts & pacman aliases |
113| [FAQ](docs/faq.md) | Common issues and solutions |
114 
115## Directory Structure
116 
117```
118~/.config/
119├── hypr/              # Hyprland (Lua config)
120│   ├── hyprland.lua   # Entry point
121│   ├── keybinds.lua   # 55+ keybinds
122│   ├── appearance.lua # Blur, opacity, borders
123│   ├── animations.lua # Window animations
124│   ├── rules.lua      # 20+ window rules
125│   ├── monitors.lua   # Monitor setup
126│   ├── input.lua      # Keyboard, mouse, touchpad
127│   └── autostart.lua  # Startup applications
128├── waybar/            # Status bar
129│   ├── config.jsonc   # Module layout (themed, 15 modules)
130│   ├── style.css      # Styling (themed)
131│   └── scripts/       # 17 custom scripts
132├── rofi/              # App launcher & menus
133│   ├── themes/        # 27 variants
134│   ├── icons/         # 8 themed SVG icons
135│   ├── scripts/       # Power, clipboard, wallpaper
136│   └── config.rasi    # Main config
137├── swaync/            # Notification center
138├── wlogout/           # Logout screen
139├── kitty/             # Terminal (themed)
140├── cava/              # Audio visualizer (themed)
141├── matugen/           # Theming engine (26 templates)
142├── quick/shelf/        # Generated Quick Shelf palette lives in ~/.config/quick/shelf
143├── fish/              # Fish shell config
144├── fastfetch/         # System fetch (custom logo)
145└── scripts/           # 10 utility scripts
146```
147 
148## Performance
149 
150bitzdots is engineered for **low-resource environments**:
151 
152| Metric | Value |
153|--------|-------|
154| **Idle RAM (full stack)** | ~250-300MB |
155| **Waybar CPU** | ~3.5% idle |
156| **Compositor** | Hyprland (~170MB) |
157| **Notification daemon** | swaync (~85MB) |
158| **Status bar** | waybar (~60MB) |
159 
160Optimization strategies are documented in **[Performance](docs/performance.md)**.
161 
162## Theming Pipeline
163 
164```
165Wallpaper image
166    ↓ matugen (Material 3 palette extraction)
167Material 3 & base16 color schemes
168    ↓ 26 templates
169Config files for every component (20+ files)
170    ↓ reload-theme.sh
171All apps pick up new colors instantly
172```
173 
174## Quick Shelf (qs) Integration
175 
176bitzdots integrates [Quick Shelf (`quickShelf`)](https://github.com/bitzzdev/quickShelf), a mouse-enabled terminal shelf and Waybar popup widget by [bitzzdev](https://github.com/bitzzdev):
177- **1:1 Default Aspect Ratio**: Centered square floating geometry (`640x640`) matching bitzdots aesthetics.
178- **Bento & List Views**: Tile card bento box and vertical list formats, toggled with `v` or `dev shelf view`.
179- **Thumbnails & App Logos**: Half-block terminal graphics and Nerd Font badges loaded for both formats.
180- **App Shortcuts**: Quick-launch pinned apps or search and add installed applications with `a`.
181- **External Drag-and-Drop**: Drag images or app shortcuts directly into external apps (Discord, GIMP, browser) with `x` or middle-click.
182- **Waybar Module & Keybinding**: Shows item count with click-to-toggle on the bar or via `SUPER + D`.
183- **Shell Command Alias**: Use `qs` or `dev shelf` directly from the shell.
184 
185To install or update the precompiled release binary:
186```bash
187dev shelf update
188```
189When updated, any running instance is automatically refreshed with a desktop notification.
190 
191## Requirements
192 
193- **Hyprland** (Wayland compositor)
194- **matugen:** Material 3 color palette generator
195- **inotify-tools:** Required by the cache daemon
196- **Nerd Font:** Provides icons, JetBrainsMono is recommended
197- **GTK 3** and **gdk-pixbuf**: for image metadata and clipboard integration
198 
199## Environment Variables
200 
201- `XDG_CONFIG_HOME`: user configuration directory (defaults to `~/.config`)
202- `XDG_DATA_HOME`: user data directory (defaults to `~/.local/share`)
203- `XDG_RUNTIME_DIR`: runtime socket directory (defaults to `/run/user/<UID>` or `/tmp`)
204- `WALLPAPER_DIR`: directory containing wallpaper images (defaults to `~/Pictures/Wallpapers`)
205 
206## Supported Distros
207 
208Arch Linux (including Arch-based), Fedora, Debian/Ubuntu, NixOS.
209 
210## Philosophy
211 
2121. **Low-end first:** Every watt and megabyte matters. Scripts are optimized for minimal CPU and RAM, not convenience.
2132. **Theme automatically:** One wallpaper change updates everything. No manual color picking.
2143. **Safe by default:** Every theme generation creates a backup. A failure won't leave broken configs.
2154. **Keyboard-driven:** Everything is within reach of the home row. The mouse is optional.
2165. **No bloat:** Every component earns its place. There are no unused default configs or unnecessary dependencies.
217 
218## License
219 
220MIT
221