quickshell-rice/ZOEY_EXPORT_GUIDE.md

# QuickShell Ecosystem: Zoey's Deployment & Setup Guide

Welcome to the **QuickShell Desktop Shell & Riced Theme Ecosystem**! This guide details how to install and run the complete self-contained desktop experience on **Zoey's computer (Nobara Linux / Fedora / Arch / Ubuntu)** directly out of her `~/.config` directory.

---

## 🌟 Architecture & Application Sync Overview

QuickShell is deployed as a 100% self-contained configuration located inside `~/.config/quickshell`:

- **Execution Directory**: `~/.config/quickshell/`
- **Systemd User Daemon**: `~/.config/systemd/user/quickshell.service` (executes `/usr/bin/quickshell -p %h/.config/quickshell`)
- **Top Status Bar**: Dynamic workspace switcher, window title tracker, CPU/RAM/Temp metrics, digital clock with calendar dropdown, system tray, audio volume, brightness, battery, and MPRIS music player controls.
- **Bottom Dock**: Floating application launcher, pinned apps, window task bar, mouse-over micro-animations, and wallpaper selector.

### 🎨 Dynamic Multi-App Theme Engine (`~/.config/quickshell/services/python/theme_sync.py`)

When picking a theme in QuickShell, `theme_sync.py` broadcasts live color schemes to all installed applications while preserving user preferences:

- **Alacritty Terminal**:
  - Main config: `~/.config/alacritty/alacritty.toml` configured with `opacity = 1.0` (fully opaque/solid background).
  - Dynamic colors: Written to `~/.config/alacritty/colors.toml` and linked via `import = ["colors.toml"]`.
  - Overriding inline `[colors]` blocks are automatically stripped so themes reload live without resetting fonts or window settings.
- **Fastfetch**:
  - `~/.config/fastfetch/config.jsonc` undergoes non-destructive regex updates for `"keys"` and `"title"` accent colors. Custom modules, logos, and ASCII layouts are fully preserved.
- **GTK 3 & GTK 4**: Live CSS rules written to `~/.config/gtk-3.0/gtk.css` and `~/.config/gtk-4.0/gtk.css`.
- **VSCode / VSCodium**: Injected into `workbench.colorCustomizations` and `editor.tokenColorCustomizations` in `settings.json`.
- **Discord** (Vesktop, Vencord, Equicord, Equibop): Live CSS themes generated in app theme directories.
- **Zen Browser**: `userChrome.css` and `userContent.css` generated per profile.
- **Feishin Music Player**: Theme JSON files written to `~/.config/feishin/Themes/` and activated in `config.json`.
- **Starship Prompt**: Palette rules written to `~/.config/starship.toml`.
- **btop**: Theme generated in `~/.config/btop/themes/quickshell.theme` and activated in `btop.conf`.
- **ghostty**: `~/.config/ghostty/config` palette updated live.
- **micro editor**: Colorscheme written to `~/.config/micro/colorschemes/quickshell.micro`.
- **vim / neovim**: `~/.vim/colors/quickshell_theme.vim` generated and loaded.
- **Konsole & KDE**: Color schemes written to `~/.local/share/konsole/Quickshell.colorscheme`.
- **Xresources**: `~/.Xresources` updated and merged via `xrdb`.

---

## 🚀 Quick Automated Installation (Recommended)

On Zoey's computer running **Nobara Linux**, open a terminal in this repository directory and run:

```bash
chmod +x install.sh
./install.sh
```

The installer will:
1. Detect Nobara (`dnf`) and install all required system packages.
2. Deploy QuickShell directly to `~/.config/quickshell/`.
3. Configure and enable `~/.config/systemd/user/quickshell.service`.
4. Trigger the initial dynamic theme sync across all supported apps.

---

## 🛠️ Step-by-Step Manual Setup for Nobara Linux

If installing manually:

### Step 1: Install Package Dependencies on Nobara (DNF)

Run the following command to install Python 3 libraries, PipeWire audio tools, DBus wrappers, and desktop utilities:

```bash
sudo dnf install -y \
    python3 python3-pillow python3-dbus \
    pipewire wireplumber brightnessctl ddcutil \
    NetworkManager bluez playerctl wl-clipboard cliphist \
    fastfetch power-profiles-daemon upower curl jq libnotify \
    lm_sensors lsblk starship alacritty wmctrl xdotool \
    qt6-qtdeclarative qt6-qtdeclarative-devel qt6-qtbase qt6-qtbase-devel \
    layer-shell-qt layer-shell-qt-devel cmake gcc-c++
```

### Step 2: Install QuickShell Engine

Check if `quickshell` is available via Fedora COPR:

```bash
sudo dnf copr enable -y outfoxxed/quickshell
sudo dnf install -y quickshell
```

*Fallback Build from Source (if package not found in COPR):*

```bash
git clone https://git.outfoxxed.me/outfoxxed/quickshell.git /tmp/quickshell-build
cd /tmp/quickshell-build
cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
cmake --build build
sudo cmake --install build
```

### Step 3: Symlink QuickShell & Fastfetch Configurations to `~/.config/`

Symlink the QuickShell ecosystem and Fastfetch Hampter configuration directly from the cloned repository so running `git pull` in the repo automatically updates `~/.config`:

```bash
mkdir -p ~/.config
ln -snf "$(pwd)/quickshell" ~/.config/quickshell
ln -snf "$(pwd)/fastfetch" ~/.config/fastfetch
chmod +x quickshell/toggle_launcher.sh
chmod +x quickshell/services/python/*.py
```

### Step 4: Configure `~/.bashrc` to Auto-run Fastfetch

Ensure `fastfetch` runs on interactive terminal startup in `~/.bashrc`:

```bash
grep -q "fastfetch" ~/.bashrc || echo -e "\n# Run fastfetch on terminal startup\nfastfetch" >> ~/.bashrc
```

### Step 5: Configure Systemd User Service

Create `~/.config/systemd/user/quickshell.service`:

```ini
[Unit]
Description=QuickShell Desktop Shell Ecosystem
After=graphical-session.target
PartOf=graphical-session.target

[Service]
Type=simple
ExecStart=/usr/bin/env quickshell -p %h/.config/quickshell
Restart=always
RestartSec=3
Environment=QT_QPA_PLATFORM=wayland
Environment=PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:%h/.local/bin:%h/.cargo/bin

[Install]
WantedBy=graphical-session.target
```

Enable and start the service:

```bash
systemctl --user daemon-reload
systemctl --user enable --now quickshell.service
```

### Step 5: Initialize Dynamic Multi-App Theme Engine

Run the theme sync engine directly out of `~/.config/quickshell/services/python/theme_sync.py`:

```bash
python3 ~/.config/quickshell/services/python/theme_sync.py \
    --bg "#22212c" --surface "#2b2938" --currentLine "#454158" \
    --fg "#f8f8f2" --accent "#9580ff" --subAccent "#ff80bf" \
    --isDark true --variantName Pro
```

---

## ⌨️ Binding the App Launcher Shortcut on Nobara / KDE

To bind the QuickShell App Launcher to the `Super` (Windows) key or a keyboard shortcut in Nobara / KDE Plasma:

1. Open **System Settings** -> **Keyboard** -> **Shortcuts**.
2. Click **Add New** -> **Command**.
3. Name: `Toggle QuickShell App Launcher`
4. Command: `~/.config/quickshell/toggle_launcher.sh`
5. Shortcut: Press `Super` or `Meta+Space` (or your preferred shortcut).
6. Click **Apply**.

---

## 🔍 Service & Process Management Commands

- **Check Shell Status**: `systemctl --user status quickshell.service`
- **Restart Desktop Shell**: `systemctl --user restart quickshell.service`
- **View Runtime Logs**: `journalctl --user -u quickshell.service -f`
- **Manual Theme Switch**: `python3 ~/.config/quickshell/services/python/theme_sync.py --bg "#1e1e2e" --surface "#313244" --currentLine "#45475a" --fg "#cdd6f4" --accent "#cba6f7" --subAccent "#89b4fa" --isDark true --variantName "Catppuccin Mocha"`

---

## 🎨 Adding Custom Wallpapers & Pinned Apps

- **Wallpapers**: Drop any `.png` or `.jpg` image into `~/.config/quickshell/wallpapers/`. QuickShell automatically indexes and displays them in the wallpaper switcher panel.
- **Pinned Apps**: Edit `~/.config/quickshell/config/pinned_apps.json` to customize default dock application icons and `.desktop` launchers.