The_miro
/
Dotfiles
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add Niri documentation and update DE references 

- docs/md/niri.md: full reference for the Niri DE — overview table,
  config file map, Niri vs Hyprland comparison, complete keybindings
  reference, EWW bar, wallpaper/lock/idle, screen rotation, installer
  instructions
- docs/md/index.md: updated tagline (Hyprland → Wayland), added Niri
  to the doc index table, updated repo layout tree
- docs/md/installation.md: Niri added to DE list; answerfile example
  updated to hyprlua
- docs/md/modules.md: hyprlua and niri added to DE table with links;
  hyprlua marked as recommended
- docs/md/hyprland.md: cross-reference to Niri docs added

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
main
Amir Alexander Abdelbaki 2026-06-01 16:40:37 +02:00
parent 7a40e9baec
commit bd4a935d51
5 changed files with 293 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/md/hyprland.md
View File

@ -1,6 +1,8 @@
# Hyprland Desktop Environment # Hyprland Desktop Environment
The Hyprland setup is the primary desktop environment — a Wayland compositor with a full ecosystem of bars, launchers, notification daemons, and theming tools. The HyprLua setup is the primary Hyprland-based desktop environment — a Wayland compositor with a full ecosystem of bars, launchers, notification daemons, and theming tools.
> **See also:** [Niri](niri.md) — an alternative scrollable-tiling Wayland compositor with the same CyberQueer theme and most of the same tools.
--- ---

11
docs/md/index.md
View File

@ -1,8 +1,8 @@
# M-Archy Dotfiles # M-Archy Dotfiles
**Arch Linux · Hyprland · Wayland · CyberQueer** **Arch Linux · Wayland · CyberQueer**
A production-grade Arch Linux configuration for network administration, development, and gaming — built around the Hyprland Wayland compositor and the CyberQueer colour theme. A production-grade Arch Linux configuration for network administration, development, and gaming — built around Wayland compositors (HyprLua and Niri) and the CyberQueer colour theme.
--- ---
@ -12,7 +12,8 @@ A production-grade Arch Linux configuration for network administration, developm
|------|-------------| |------|-------------|
| [Installation](installation.md) | Interactive TUI installer, answerfile automation, ISO building | | [Installation](installation.md) | Interactive TUI installer, answerfile automation, ISO building |
| [Theming](theming.md) | CyberQueer colour system and `apply-theme.sh` | | [Theming](theming.md) | CyberQueer colour system and `apply-theme.sh` |
| [Hyprland](hyprland.md) | Desktop environment, keybindings, bars, launchers | | [Hyprland](hyprland.md) | HyprLua desktop environment — keybindings, bars, launchers |
| [Niri](niri.md) | Niri scrollable-tiling compositor — config, keybindings, tools |
| [Modules](modules.md) | Core modules and full optional-app catalogue | | [Modules](modules.md) | Core modules and full optional-app catalogue |
| [Archiso](archiso.md) | Building the custom live installer ISO | | [Archiso](archiso.md) | Building the custom live installer ISO |
| [FreeIPA & Ansible](freeipa-ansible.md) | Identity management and automated config deployment | | [FreeIPA & Ansible](freeipa-ansible.md) | Identity management and automated config deployment |
@ -66,7 +67,9 @@ Dotfiles/
│ ├── install-modules.sh # Add optional modules to existing system │ ├── install-modules.sh # Add optional modules to existing system
│ ├── archiso/ # Custom Arch live ISO builder │ ├── archiso/ # Custom Arch live ISO builder
│ └── modules/ # Modular install scripts │ └── modules/ # Modular install scripts
├── desktopenvs/hyprland/ # All Hyprland / Wayland configs ├── desktopenvs/hyprlua/ # HyprLua (Lua-based Hyprland) configs
├── desktopenvs/niri/ # Niri scrollable-tiling compositor configs
├── desktopenvs/hyprland/ # Legacy Hyprlang Hyprland configs
├── gtk-themes/cyberqueer/ # GTK 3 & 4 theme ├── gtk-themes/cyberqueer/ # GTK 3 & 4 theme
├── qt-themes/cyberqueer/ # Qt platform theme ├── qt-themes/cyberqueer/ # Qt platform theme
├── nvim/ # Neovim config ├── nvim/ # Neovim config

4
docs/md/installation.md
View File

@ -35,7 +35,7 @@ The TUI walks you through:
- `core` — 100+ base system packages - `core` — 100+ base system packages
- `svc` — core services (NetworkManager, cronie, fail2ban, greetd) - `svc` — core services (NetworkManager, cronie, fail2ban, greetd)
- `shell` — zsh, Neovim, Yazi, Micro, Starship - `shell` — zsh, Neovim, Yazi, Micro, Starship
3. **Desktop Environment** — Hyprland, Sway, KDE Plasma, GNOME, COSMIC, XFCE, LXQt, or none 3. **Desktop Environment** — HyprLua, Niri, Hyprland, Sway, KDE Plasma, GNOME, COSMIC, XFCE, LXQt, or none
4. **Applications** — checklist of ~50 optional apps (see [Modules](modules.md)) 4. **Applications** — checklist of ~50 optional apps (see [Modules](modules.md))
5. **Colorway** — optional; enter hex values to customise the CyberQueer palette 5. **Colorway** — optional; enter hex values to customise the CyberQueer palette
@ -80,7 +80,7 @@ This dry-runs every installer dialog and saves your choices. **No software is in
"fido2_user": false, "fido2_user": false,
"run_tui": true, "run_tui": true,
"components": ["pkg", "core", "svc", "shell"], "components": ["pkg", "core", "svc", "shell"],
"desktop_environment": "hyprland", "desktop_environment": "hyprlua",
"apps": ["firefox-browser", "vscodium", "docker"], "apps": ["firefox-browser", "vscodium", "docker"],
"colors": { "colors": {
"COLOR_TEXT": "D6ABAB", "COLOR_TEXT": "D6ABAB",

4
docs/md/modules.md
View File

@ -53,7 +53,9 @@ Also deploys `greetd-tuigreet` config from the dotfiles.
| ID | Name | Notes | | ID | Name | Notes |
|----|------|-------| |----|------|-------|
| `hyprland` | Hyprland | Primary DE — see [Hyprland](hyprland.md) | | `hyprlua` | HyprLua | Lua-based Hyprland — recommended — see [Hyprland](hyprland.md) |
| `niri` | Niri | Scrollable-tiling Wayland compositor — see [Niri](niri.md) |
| `hyprland` | Hyprland | Legacy Hyprlang config |
| `sway` | Sway | Wayland tiling WM, lighter | | `sway` | Sway | Wayland tiling WM, lighter |
| `kde-plasma` | KDE Plasma | Full-featured with sddm | | `kde-plasma` | KDE Plasma | Full-featured with sddm |
| `gnome` | GNOME | Modern Wayland DE with gdm | | `gnome` | GNOME | Modern Wayland DE with gdm |

278
docs/md/niri.md Normal file
View File

@ -0,0 +1,278 @@
# Niri Desktop Environment
Niri is a scrollable-tiling Wayland compositor written in Rust. Unlike Hyprland's dwindle/master layouts, Niri arranges windows in **columns that scroll horizontally** within each workspace — think a continuous horizontal strip instead of a fixed grid.
---
## Overview
| Component | Role |
|-----------|------|
| **Niri** | Wayland scrollable-tiling compositor |
| **Kitty** | Primary terminal emulator |
| **EWW** | Status bar (three device variants) |
| **Waybar** | Alternative status bar |
| **Wofi** | App launcher (keyboard-driven) |
| **Walker** | Fast CLI launcher |
| **uLauncher** | GUI app launcher |
| **Dunst** | Notification daemon |
| **swaylock** | Screen locker |
| **swaybg** | Wallpaper daemon |
| **swayidle** | Idle management (lock, suspend) |
| **gammastep** | Colour temperature (night light) |
| **nwg-drawer** | Application drawer |
| **nwg-panel** | Desktop menu |
| **Vicinae** | Gesture-triggered context launcher |
| **xfce-polkit** | PolicyKit authentication agent |
| **ly** | TUI login manager |
---
## Config File Map
```
desktopenvs/niri/
├── niri/
│ └── config.kdl # Single KDL config — everything in one file
├── greetd-tuigreet/
│ └── config.toml # Greeter → launches niri
├── scripts/ # Utility scripts (niri-adapted)
│ ├── ewwstart.sh # Start EWW bar (niri monitor detection)
│ ├── togglebar.sh # Show/hide EWW bar
│ ├── monitorhandler.sh # swaybg wallpaper + eww bar on startup
│ ├── caffeine.sh # Toggle swayidle (prevent sleep)
│ ├── activewindow # Focused window title for EWW
│ ├── workspace # Workspace widget (niri event-stream)
│ ├── wallpaper-picker # swaybg-based wallpaper picker
│ ├── unified-rotate.sh # Screen rotation via niri IPC
│ ├── niri-toggle-touchpad.sh # Touchpad on/off (xinput)
│ ├── windowswitcher # Window list via niri msg + wofi
│ ├── drawer.sh # nwg-drawer launcher
│ └── [shared with hyprlua] # screenshot.sh, screenrec.sh, etc.
├── eww/ # EWW bar (PC, no battery)
├── eww-nobattery/ # EWW bar (desktop alias)
├── eww-touch/ # EWW bar (laptop/tablet + battery)
├── config-updater/
│ └── updater.conf # Config sync manifest
│
│ # Shared configs — symlinked from desktopenvs/hyprlua/
├── kitty → ../hyprlua/kitty
├── dunst → ../hyprlua/dunst
├── wofi → ../hyprlua/wofi
├── btop → ../hyprlua/btop
├── walker → ../hyprlua/walker
├── vicinae → ../hyprlua/vicinae
└── [alacritty, gtk-3.0, ulauncher, xfce4, waybar, nwg-drawer, ...]
```
---
## Niri vs Hyprland — Key Differences
| Feature | HyprLua | Niri |
|---------|---------|------|
| Layout model | Dwindle / Master | Scrollable columns |
| Config format | Lua (`hyprland.lua`) | KDL (`config.kdl`) |
| Workspace direction | Horizontal (1→9) | Vertical (stacked) |
| Wallpaper | hyprpaper | swaybg |
| Screen locker | hyprlock | swaylock |
| Idle daemon | hypridle | swayidle |
| Colour temp | hyprsunset | gammastep |
| Polkit agent | hyprpolkitagent | xfce-polkit |
| Dock | nwg-dock-hyprland | — (not compatible) |
| IPC tool | `hyprctl` | `niri msg` |
> **No dock:** nwg-dock-hyprland uses the `wlr-foreign-toplevel-management` protocol which niri does not implement. The app drawer (`nwg-drawer`) and launcher (`vicinae`) serve the same role.
---
## Keybindings
All bindings are defined in `niri/config.kdl` under the `binds { }` section. Edit with `Mod+Shift+F1`.
### Applications
| Binding | Action |
|---------|--------|
| `Super + T` | Kitty terminal |
| `Super + Shift + T` | Cool Retro Term |
| `Super + M` | Kitty + Neovim |
| `Super + E` | Thunar file manager |
| `Super + Alt + E` | PCManFM-Qt |
| `Super + X` | Wofi run launcher |
| `Super + R` / `Super + Return` | Vicinae launcher |
| `Super + Shift + R` | Wofi drun |
| `Super + F` | File search |
| `Super + Shift + F` | Folder search |
| `Super + Alt + F` | Wofi calculator |
| `Super + S` | PulseAudio mixer (pavucontrol) |
| `Super + U` | btop system monitor |
| `Super + W` | Wallpaper picker |
| `Super + D` | App drawer (nwg-drawer) |
| `Super + I` | Network menu (iwmenu) |
| `Super + N` | Nextcloud |
### Window Management
| Binding | Action |
|---------|--------|
| `Super + Q` | Close window |
| `Super + V` | Toggle floating |
| `Super + Shift + V` / `Super + C` | Centre column |
| `Super + Backspace` | Cycle preset column width |
| `Super + Shift + Backspace` | Maximise column |
| `Super + Ctrl + Backspace` | Fullscreen |
| `Super + A` | Consume window into column |
| `Super + Y` | Expel window from column |
### Focus & Move
| Binding | Action |
|---------|--------|
| `Super + H / L / J / K` | Focus column left/right, window up/down |
| `Super + Arrow keys` | Same as above |
| `Super + Tab` | Focus next window/column |
| `Super + Shift + H/L/J/K` | Move column/window |
| `Super + Alt + H/L/J/K` | Resize column/window |
### Workspaces
> Niri workspaces are **vertical** — they stack top-to-bottom on each output.
> `Ctrl+L` goes **down** (next workspace), `Ctrl+H` goes **up** (previous).
| Binding | Action |
|---------|--------|
| `Super + [1–9]` | Switch to workspace N |
| `Super + Shift + [1–9]` | Move column to workspace N |
| `Super + Ctrl + L / Right` | Next workspace (down) |
| `Super + Ctrl + H / Left` | Previous workspace (up) |
| `Super + Ctrl + Shift + L/H` | Move column to next/prev workspace |
| `Super + Scroll up/down` | Navigate workspaces |
| `Super + Space` | Focus workspace with recent window |
### System
| Binding | Action |
|---------|--------|
| `Super + O` | Lock screen (swaylock) |
| `Super + Shift + O` | Quit niri |
| `Super + Ctrl + O` | Shutdown |
| `Super + Alt + O` | Power menu |
| `Super + Z` | Toggle EWW bar |
| `Super + Ctrl + B` | Reload EWW |
| `Super + Shift + C` | Toggle caffeine (swayidle) |
| `Super + Ctrl + P` | Start/stop screen recording |
| `Print` / `Super + P` | Screenshot (region) |
| `Super + Shift + P` | Screenshot full screen |
### Audio / Brightness
| Binding | Action |
|---------|--------|
| `XF86AudioRaiseVolume` | Volume +5% |
| `XF86AudioLowerVolume` | Volume -5% |
| `XF86AudioMute` | Mute toggle |
| `XF86AudioPlay` | Play/pause |
| `XF86MonBrightnessUp/Down` | Brightness |
### Colour Temperature (gammastep)
Unlike hyprsunset, gammastep has no runtime IPC. Each binding kills and restarts it at a preset:
| Binding | Temperature |
|---------|-------------|
| `Super + Ctrl + X` | 6500 K (neutral / reset) |
| `Super + Ctrl + W` | 5000 K (warm) |
| `Super + Ctrl + A` | 4000 K (warmer) |
| `Super + Ctrl + Q` | 3000 K (very warm) |
| `Super + Ctrl + S` | 2700 K (night mode) |
---
## Status Bar (EWW)
Three EWW bar variants — installed during setup:
| Variant | Target device | Battery widget |
|---------|---------------|----------------|
| `eww/` | Desktop PC | No |
| `eww-nobattery/` | Desktop PC | No |
| `eww-touch/` | Laptop / tablet | Yes |
The workspace widget uses `~/.config/scripts/workspace` — a bash script that listens to `niri msg event-stream` and outputs EWW Yuck literals whenever workspaces change.
The EWW style (`eww.scss`) is shared with hyprlua via symlink — CyberQueer colours apply identically.
---
## Wallpaper
The wallpaper is managed by `swaybg`. At startup `monitorhandler.sh` runs:
```bash
swaybg -m fill -i ~/Pictures/background.jpg &
```
To pick a wallpaper interactively:
```
Super + W
```
This opens `wallpaper-picker` in a Kitty terminal — navigate with `h/l`, apply with `Enter`, quit with `q`. The selected image is reloaded via `swaybg` and saved to `~/.config/niri-wallpaper`.
---
## Screen Lock & Idle
**swaylock** is the screen locker (`Super + O` or via swayidle timeout).
**swayidle** launches at startup with:
- 5 min idle → `swaylock -f`
- 10 min idle → `systemctl suspend`
- before sleep → `swaylock -f`
**Caffeine mode** (`Super + Shift + C`) kills swayidle and restarts it when toggled off.
---
## Screen Rotation
`Super + Ctrl + E` (clockwise) and `Super + Ctrl + D` (anti-clockwise) call `unified-rotate.sh`, which uses `niri msg action set-output-transform` on the currently focused output.
---
## Config Updater
The config updater syncs `desktopenvs/niri/` into `~/.config/`:
```bash
~/update-configs.sh
```
Config: `~/.config/config-updater/updater.conf`
Managed entries: `niri`, `kitty`, `dunst`, `wofi`, `scripts`, and more.
---
## Installing Niri
```bash
# Via the TUI installer
bash ~/Dotfiles/setup/tui-install.sh
# → select "Niri" in the Desktop Environment dialog
# Direct script (on an existing Arch system)
bash ~/Dotfiles/setup/modules/Desktop-Environments/niri.sh
```
The installer:
1. Installs all packages (niri, swaybg, swaylock, swayidle, gammastep, xfce-polkit, etc.)
2. Compiles EWW from source (requires Rust)
3. Copies all configs to `~/.config/`
4. Deploys greetd config to `/etc/greetd/config.toml`
5. Installs CyberQueer GTK theme and Nordzy-cursors-lefthand
6. Enables `ly@tty1`, `NetworkManager`, `bluetooth`, `iwd`, `udisks2`
7. Installs Python venv for scripts
8. Sets up the config-updater symlinks