Dotfiles/docs/html/hyprland.html

781 lines
22 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Hyprland Desktop Environment — M-Archy Dotfiles</title>
<style>
/* ── CyberQueer Theme ──────────────────────────────────────────────── */
:root {
--bg: #1A1A1A;
--bg2: #242424;
--bg3: #2e2e2e;
--text: #D6ABAB;
--accent: #E40046;
--violet: #5018DD;
--danger: #F50505;
--border: #5018DD;
--radius: 10px;
--radius-sm: 5px;
}
/* ── Reset & Base ──────────────────────────────────────────────────── */
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
html { scroll-behavior: smooth; }
body {
background-color: var(--bg);
color: var(--text);
font-family: 'Agave Nerd Font Mono', 'JetBrains Mono', 'Fira Code',
'Cascadia Code', 'Source Code Pro', monospace;
font-size: 15px;
line-height: 1.75;
max-width: 960px;
margin: 0 auto;
padding: 2.5rem 2rem 5rem;
}
/* ── Typography ────────────────────────────────────────────────────── */
h1, h2, h3, h4, h5, h6 {
font-family: 'Agave Nerd Font Mono', monospace;
font-weight: 700;
line-height: 1.25;
margin-top: 2.2rem;
margin-bottom: 0.6rem;
}
h1 {
color: var(--accent);
font-size: 2.2rem;
border-bottom: 3px solid var(--accent);
padding-bottom: 0.4rem;
margin-top: 0;
}
h2 {
color: var(--accent);
font-size: 1.55rem;
border-bottom: 2px solid var(--violet);
padding-bottom: 0.3rem;
}
h3 {
color: var(--violet);
font-size: 1.2rem;
}
h4, h5, h6 {
color: var(--text);
font-size: 1rem;
}
p {
margin: 0.9rem 0;
}
strong { color: var(--accent); font-weight: 700; }
em { color: var(--violet); font-style: italic; }
/* ── Links ─────────────────────────────────────────────────────────── */
a {
color: var(--violet);
text-decoration: none;
border-bottom: 1px solid transparent;
transition: color 0.15s, border-color 0.15s;
}
a:hover {
color: var(--accent);
border-bottom-color: var(--accent);
}
/* ── Code ──────────────────────────────────────────────────────────── */
code {
font-family: inherit;
background: var(--bg2);
color: var(--violet);
border: 1px solid var(--violet);
border-radius: var(--radius-sm);
padding: 0.1em 0.42em;
font-size: 0.9em;
}
pre {
background: var(--bg2);
border: 2px solid var(--violet);
border-radius: var(--radius);
padding: 1.2rem 1.4rem;
overflow-x: auto;
margin: 1.2rem 0;
position: relative;
}
pre code {
background: transparent;
border: none;
padding: 0;
color: var(--text);
font-size: 0.875em;
line-height: 1.6;
}
/* Syntax-like token colouring (no JS required — structural only) */
pre code .kw { color: var(--accent); }
pre code .str { color: var(--violet); }
pre code .cm { color: #666; font-style: italic; }
/* ── Horizontal Rule ───────────────────────────────────────────────── */
hr {
border: none;
border-top: 2px solid var(--violet);
margin: 2rem 0;
opacity: 0.45;
}
/* ── Blockquote ────────────────────────────────────────────────────── */
blockquote {
border-left: 4px solid var(--accent);
background: var(--bg2);
margin: 1.2rem 0;
padding: 0.8rem 1.2rem;
border-radius: 0 var(--radius) var(--radius) 0;
color: var(--text);
opacity: 0.9;
}
blockquote p { margin: 0; }
/* ── Tables ────────────────────────────────────────────────────────── */
table {
width: 100%;
border-collapse: collapse;
border: 2px solid var(--border);
border-radius: var(--radius);
overflow: hidden;
margin: 1.2rem 0;
font-size: 0.9em;
}
th {
background: var(--violet);
color: var(--bg);
text-align: left;
padding: 0.55rem 0.9rem;
font-weight: 700;
letter-spacing: 0.03em;
}
td {
padding: 0.5rem 0.9rem;
border-top: 1px solid var(--bg3);
vertical-align: top;
}
tr:nth-child(even) td { background: var(--bg2); }
tr:hover td { background: var(--bg3); }
/* ── Lists ─────────────────────────────────────────────────────────── */
ul, ol {
padding-left: 1.6rem;
margin: 0.7rem 0;
}
li { margin: 0.25rem 0; }
ul li::marker { color: var(--accent); }
ol li::marker { color: var(--violet); font-weight: 700; }
/* ── Nav sidebar (index page) ──────────────────────────────────────── */
nav ul {
list-style: none;
padding: 0;
}
nav li { margin: 0.3rem 0; }
/* ── Page Header Bar ───────────────────────────────────────────────── */
.page-header {
border-bottom: 3px solid var(--accent);
padding-bottom: 0.6rem;
margin-bottom: 2rem;
display: flex;
align-items: baseline;
gap: 1rem;
}
.page-header .site-title {
color: var(--accent);
font-size: 0.85rem;
opacity: 0.75;
white-space: nowrap;
}
/* ── Back link ─────────────────────────────────────────────────────── */
.back-link {
display: inline-block;
color: var(--violet);
font-size: 0.85rem;
margin-bottom: 1.5rem;
padding: 0.25rem 0.75rem;
border: 1px solid var(--violet);
border-radius: 30px;
transition: background 0.15s, color 0.15s;
}
.back-link:hover {
background: var(--violet);
color: var(--bg);
border-bottom-color: transparent;
}
/* ── Footer ────────────────────────────────────────────────────────── */
footer {
margin-top: 4rem;
padding-top: 1rem;
border-top: 1px solid var(--bg3);
color: var(--text);
opacity: 0.4;
font-size: 0.8rem;
text-align: center;
}
/* ── Responsive ────────────────────────────────────────────────────── */
@media (max-width: 680px) {
body { padding: 1.2rem 1rem 3rem; font-size: 14px; }
h1 { font-size: 1.7rem; }
h2 { font-size: 1.3rem; }
table { display: block; overflow-x: auto; }
}
/* ── Selection ─────────────────────────────────────────────────────── */
::selection {
background: var(--accent);
color: var(--bg);
}
/* ── Scrollbar ─────────────────────────────────────────────────────── */
::-webkit-scrollbar { width: 8px; height: 8px; }
::-webkit-scrollbar-track { background: var(--bg2); }
::-webkit-scrollbar-thumb { background: var(--violet); border-radius: 4px; }
::-webkit-scrollbar-thumb:hover { background: var(--accent); }
</style>
</head>
<body>
<header class="page-header">
<span class="site-title">M-Archy Dotfiles</span>
</header>
<a class="back-link" href="index.html">← Index</a>
<main>
<h1 id="hyprland-desktop-environment">Hyprland Desktop Environment<a class="toc-anchor" href="#hyprland-desktop-environment" title="Permanent link">&para;</a></h1>
<p>The Hyprland setup is the primary desktop environment — a Wayland compositor with a full ecosystem of bars, launchers, notification daemons, and theming tools.</p>
<hr />
<h2 id="overview">Overview<a class="toc-anchor" href="#overview" title="Permanent link">&para;</a></h2>
<table>
<thead>
<tr>
<th>Component</th>
<th>Role</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Hyprland</strong></td>
<td>Wayland tiling compositor (dwindle layout)</td>
</tr>
<tr>
<td><strong>Kitty</strong></td>
<td>Primary terminal emulator</td>
</tr>
<tr>
<td><strong>EWW</strong></td>
<td>Status bar (three device variants)</td>
</tr>
<tr>
<td><strong>Waybar</strong></td>
<td>Alternative status bar</td>
</tr>
<tr>
<td><strong>Wofi</strong></td>
<td>App launcher (keyboard-driven)</td>
</tr>
<tr>
<td><strong>Walker</strong></td>
<td>Fast CLI launcher</td>
</tr>
<tr>
<td><strong>uLauncher</strong></td>
<td>GUI app launcher</td>
</tr>
<tr>
<td><strong>Dunst</strong></td>
<td>Notification daemon</td>
</tr>
<tr>
<td><strong>Hyprlock</strong></td>
<td>Screen locker</td>
</tr>
<tr>
<td><strong>Hyprpaper</strong></td>
<td>Wallpaper daemon</td>
</tr>
<tr>
<td><strong>Hypridle</strong></td>
<td>Idle management (sleep, lock)</td>
</tr>
<tr>
<td><strong>nwg-dock</strong></td>
<td>Application dock</td>
</tr>
<tr>
<td><strong>nwg-drawer</strong></td>
<td>Application drawer</td>
</tr>
<tr>
<td><strong>nwg-panel</strong></td>
<td>Desktop menu</td>
</tr>
<tr>
<td><strong>Vicinae</strong></td>
<td>Gesture-triggered context launcher</td>
</tr>
<tr>
<td><strong>ly</strong></td>
<td>TUI login manager</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="config-file-map">Config File Map<a class="toc-anchor" href="#config-file-map" title="Permanent link">&para;</a></h2>
<pre><code>desktopenvs/hyprland/
├── hypr/
│ ├── hyprland.conf # Root config — imports all below
│ ├── hyprtoolkit.conf # Toolkit utilities
│ ├── hyprlock.conf # Lock screen
│ ├── hypridle.conf # Idle timeouts
│ └── hyprpaper.conf # Wallpaper
├── hypr-usr/ # Per-user override layer
│ ├── binds.conf # All keybindings
│ ├── input.conf # Keyboard/mouse settings
│ ├── monitors.conf # Display layout
│ ├── windowrules.conf # Per-app behaviour rules
│ └── autostart.conf # Startup programs
├── kitty/
│ ├── kitty.conf # Terminal config
│ ├── current-theme.conf # Active palette (CyberQueer)
│ └── themes/cyberqueer.conf # Theme definition
├── waybar/
│ ├── config # Module layout and data sources
│ └── style.css # CyberQueer styling
├── wofi/style.css # Launcher styling
├── walker/themes/ # Walker theme (cyberqueer.css)
├── dunst/ # Notification styling
├── eww/ # EWW bar (PC — no battery)
├── eww-nobattery/ # EWW bar alias
├── eww-touch/ # EWW bar (tablet / touchscreen)
├── spicetify/ # Spotify CyberQueer themes
├── Vencord/ # Discord CyberQueer themes
├── btop/ # System monitor + cyberqueer.theme
├── scripts/ # 20+ utility scripts
└── config-updater/ # Config synchronisation tool
</code></pre>
<hr />
<h2 id="keybindings">Keybindings<a class="toc-anchor" href="#keybindings" title="Permanent link">&para;</a></h2>
<p>All bindings live in <code>hypr-usr/binds.conf</code>.</p>
<h3 id="applications">Applications<a class="toc-anchor" href="#applications" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Binding</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Super + T</code></td>
<td>Kitty terminal</td>
</tr>
<tr>
<td><code>Super + Shift + T</code></td>
<td>Cool Retro Term (CRT profile)</td>
</tr>
<tr>
<td><code>Super + M</code></td>
<td>Micro editor</td>
</tr>
<tr>
<td><code>Super + E</code></td>
<td>Thunar file manager</td>
</tr>
<tr>
<td><code>Super + X</code></td>
<td>Wofi app launcher</td>
</tr>
<tr>
<td><code>Super + F</code></td>
<td>File search (wofi)</td>
</tr>
<tr>
<td><code>Super + Shift + F</code></td>
<td>Folder search (wofi)</td>
</tr>
</tbody>
</table>
<h3 id="window-management">Window Management<a class="toc-anchor" href="#window-management" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Binding</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Super + Q</code></td>
<td>Close focused window</td>
</tr>
<tr>
<td><code>Super + V</code></td>
<td>Toggle floating</td>
</tr>
<tr>
<td><code>Super + Shift + V</code></td>
<td>Centre floating window</td>
</tr>
<tr>
<td><code>Super + P</code></td>
<td>Toggle pseudo-tiling</td>
</tr>
<tr>
<td><code>Super + J</code></td>
<td>Toggle split direction</td>
</tr>
<tr>
<td><code>Super + Arrow / hjkl</code></td>
<td>Focus window by direction</td>
</tr>
<tr>
<td><code>Super + Shift + Arrow / hjkl</code></td>
<td>Move window by direction</td>
</tr>
<tr>
<td><code>Super + [0-9]</code></td>
<td>Switch workspace</td>
</tr>
<tr>
<td><code>Super + Shift + [0-9]</code></td>
<td>Move window to workspace</td>
</tr>
<tr>
<td><code>Super + mouse drag</code></td>
<td>Move/resize floating window</td>
</tr>
</tbody>
</table>
<h3 id="system">System<a class="toc-anchor" href="#system" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Binding</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Super + O</code></td>
<td>Lock screen (hyprlock)</td>
</tr>
<tr>
<td><code>Super + Alt + O</code></td>
<td>Power menu</td>
</tr>
<tr>
<td><code>Super + Ctrl + O</code></td>
<td>Shutdown immediately</td>
</tr>
<tr>
<td><code>Super + Z</code></td>
<td>Toggle EWW bar</td>
</tr>
<tr>
<td><code>Super + Ctrl + P</code></td>
<td>Start screen recording</td>
</tr>
</tbody>
</table>
<h3 id="touchpad-gestures">Touchpad Gestures<a class="toc-anchor" href="#touchpad-gestures" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Gesture</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td>3-finger swipe left/right</td>
<td>Switch workspace</td>
</tr>
<tr>
<td>3-finger swipe up/down</td>
<td>Move window to workspace</td>
</tr>
<tr>
<td>3-finger pinch</td>
<td>Toggle overview</td>
</tr>
<tr>
<td>4-finger tap</td>
<td>Open launcher</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="status-bar-eww">Status Bar (EWW)<a class="toc-anchor" href="#status-bar-eww" title="Permanent link">&para;</a></h2>
<p>EWW (Elkowar's Wayland Window Manager) is compiled from source during Hyprland install and comes in three variants:</p>
<table>
<thead>
<tr>
<th>Variant</th>
<th>Device</th>
<th>Battery Widget</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>eww/</code></td>
<td>Desktop PC</td>
<td>No</td>
</tr>
<tr>
<td><code>eww-nobattery/</code></td>
<td>Desktop PC</td>
<td>No</td>
</tr>
<tr>
<td><code>eww-touch/</code></td>
<td>Laptop / tablet</td>
<td>Yes</td>
</tr>
</tbody>
</table>
<p>During install the EWW installer asks which variant to use.</p>
<h3 id="waybar">Waybar<a class="toc-anchor" href="#waybar" title="Permanent link">&para;</a></h3>
<p>An alternative to EWW — always installed. The bar layout:</p>
<ul>
<li><strong>Left</strong>: clock, disk usage, RAM, CPU, temperature</li>
<li><strong>Centre</strong>: workspace switcher, active window title</li>
<li><strong>Right</strong>: network speed, IP address, system tray, audio volume, battery (if present)</li>
</ul>
<hr />
<h2 id="launchers">Launchers<a class="toc-anchor" href="#launchers" title="Permanent link">&para;</a></h2>
<h3 id="wofi">Wofi<a class="toc-anchor" href="#wofi" title="Permanent link">&para;</a></h3>
<p>Keyboard-driven app/file launcher. Activated with <code>Super + X</code>.<br />
Config: <code>wofi/style.css</code> — themed with CyberQueer colours.</p>
<h3 id="walker">Walker<a class="toc-anchor" href="#walker" title="Permanent link">&para;</a></h3>
<p>Fast CLI launcher (<code>walker</code>). Pre-configured with <code>walker/config.toml</code> and the <code>cyberqueer.css</code> / <code>cyberqueer.toml</code> theme files.</p>
<h3 id="ulauncher">uLauncher<a class="toc-anchor" href="#ulauncher" title="Permanent link">&para;</a></h3>
<p>GUI launcher with plugin support. Theme: <code>ulauncher/user-themes/cyberqueer/</code>.<br />
Colours in the theme are colour-substitution targets (updated by <code>apply-theme.sh</code>).</p>
<hr />
<h2 id="notification-daemon-dunst">Notification Daemon (Dunst)<a class="toc-anchor" href="#notification-daemon-dunst" title="Permanent link">&para;</a></h2>
<p>Lightweight notification daemon. Config in <code>dunst/dunstrc</code>.<br />
Notifications appear top-right with CyberQueer styling.</p>
<hr />
<h2 id="lock-screen-hyprlock">Lock Screen (Hyprlock)<a class="toc-anchor" href="#lock-screen-hyprlock" title="Permanent link">&para;</a></h2>
<p><code>hyprlock</code> is the Wayland screen locker. Config at <code>hypr/hyprlock.conf</code>.<br />
Activated by <code>Super + O</code> or automatically via <code>hypridle</code> after idle timeout.</p>
<hr />
<h2 id="scripts-reference">Scripts Reference<a class="toc-anchor" href="#scripts-reference" title="Permanent link">&para;</a></h2>
<p>All scripts live in <code>desktopenvs/hyprland/scripts/</code> and are deployed to <code>~/.config/scripts/</code>.</p>
<table>
<thead>
<tr>
<th>Script</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>caffeine.sh</code></td>
<td>Toggle hypridle (prevent sleep)</td>
</tr>
<tr>
<td><code>ewwstart.sh</code></td>
<td>Launch EWW bar on startup</td>
</tr>
<tr>
<td><code>ewwstart-niri.sh</code></td>
<td>EWW for niri compositor variant</td>
</tr>
<tr>
<td><code>togglebar.sh</code></td>
<td>Show/hide EWW bar (monitor-aware)</td>
</tr>
<tr>
<td><code>helpmenu.sh</code></td>
<td>Display keybindings from binds.conf</td>
</tr>
<tr>
<td><code>screenshot.sh</code></td>
<td>Region/full screenshot via grim + slurp</td>
</tr>
<tr>
<td><code>screenrec.sh</code></td>
<td>Screen recording</td>
</tr>
<tr>
<td><code>screenrotationacw.sh</code></td>
<td>Rotate screen anti-clockwise (tablet)</td>
</tr>
<tr>
<td><code>screenrotationwcw.sh</code></td>
<td>Rotate screen clockwise (tablet)</td>
</tr>
<tr>
<td><code>unified-rotate.sh</code></td>
<td>Unified rotation handler</td>
</tr>
<tr>
<td><code>hyprland-toggle-touchpad.sh</code></td>
<td>Enable/disable touchpad</td>
</tr>
<tr>
<td><code>wofi-file-search.sh</code></td>
<td>File search via wofi</td>
</tr>
<tr>
<td><code>foldersearch.sh</code></td>
<td>Folder search via wofi</td>
</tr>
<tr>
<td><code>pwr-dmenu.sh</code></td>
<td>Power menu (shutdown/reboot/suspend)</td>
</tr>
<tr>
<td><code>caffeine.sh</code></td>
<td>Toggle idle inhibitor</td>
</tr>
<tr>
<td><code>getispeed.sh</code></td>
<td>Internet speed test display</td>
</tr>
<tr>
<td><code>journal.sh</code></td>
<td>Quick journal entry</td>
</tr>
<tr>
<td><code>date.sh</code> / <code>time.sh</code></td>
<td>Date/time waybar helpers</td>
</tr>
<tr>
<td><code>uptime.sh</code></td>
<td>Uptime display</td>
</tr>
<tr>
<td><code>dysk-phydisks.sh</code></td>
<td>Physical disk info (dysk)</td>
</tr>
<tr>
<td><code>drawer.sh</code></td>
<td>Open nwg-drawer</td>
</tr>
<tr>
<td><code>menu.sh</code></td>
<td>Application menu</td>
</tr>
<tr>
<td><code>onscreenkb.sh</code></td>
<td>On-screen keyboard (wvkbd)</td>
</tr>
<tr>
<td><code>bluetooth-applet.sh</code></td>
<td>Bluetooth UI wrapper</td>
</tr>
<tr>
<td><code>togglewinbars.sh</code></td>
<td>Toggle window title bars</td>
</tr>
<tr>
<td><code>toggle-layout.sh</code></td>
<td>Switch tiling layout</td>
</tr>
<tr>
<td><code>playpause.sh</code></td>
<td>Media play/pause</td>
</tr>
<tr>
<td><code>calender-fix.sh</code></td>
<td>Calendar waybar widget fix</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="application-theming">Application Theming<a class="toc-anchor" href="#application-theming" title="Permanent link">&para;</a></h2>
<h3 id="spotify-spicetify">Spotify (Spicetify)<a class="toc-anchor" href="#spotify-spicetify" title="Permanent link">&para;</a></h3>
<p>Two CyberQueer Spicetify themes are available:</p>
<table>
<thead>
<tr>
<th>Theme</th>
<th>Style</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cli-cyberqueer</code></td>
<td>CLI-inspired, minimal</td>
</tr>
<tr>
<td><code>matte-cyberqueer</code></td>
<td>Matte finish variant</td>
</tr>
</tbody>
</table>
<p>Applied automatically when the <code>spotify</code> module is installed.</p>
<h3 id="discord-vencord">Discord (Vencord)<a class="toc-anchor" href="#discord-vencord" title="Permanent link">&para;</a></h3>
<p>Two Discord themes:</p>
<table>
<thead>
<tr>
<th>Theme</th>
<th>Location</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cyberqueer.theme.css</code></td>
<td>Standalone CyberQueer theme</td>
</tr>
<tr>
<td><code>system24/…/cyberqueer.theme.css</code></td>
<td>system24 framework with CyberQueer colours</td>
</tr>
</tbody>
</table>
<h3 id="terminal-kitty">Terminal (Kitty)<a class="toc-anchor" href="#terminal-kitty" title="Permanent link">&para;</a></h3>
<p>The <code>kitty/themes/cyberqueer.conf</code> file defines the full 16-colour palette mapped to CyberQueer values. It is sourced by <code>current-theme.conf</code> which is imported in <code>kitty.conf</code>.</p>
<hr />
<h2 id="login-manager-ly">Login Manager (ly)<a class="toc-anchor" href="#login-manager-ly" title="Permanent link">&para;</a></h2>
<p><code>ly</code> is a TUI display manager configured via <code>etc-ly-config.ini</code> (deployed to <code>/etc/ly/config.ini</code>). Its colours are tracked by <code>apply-theme.sh</code> (system file, applied via <code>sudo</code>).</p>
<hr />
<h2 id="installing-hyprland">Installing Hyprland<a class="toc-anchor" href="#installing-hyprland" title="Permanent link">&para;</a></h2>
<pre><code class="language-bash"># Via the TUI installer
bash ~/Dotfiles/setup/tui-install.sh
# → Select &quot;shell&quot; and &quot;Hyprland&quot; in the dialogs
# On an existing system
bash ~/Dotfiles/setup/install-modules.sh
# → Not available; Hyprland is a base DE, use the full installer
# Direct script
bash ~/Dotfiles/setup/modules/Desktop-Environments/hyprland.sh
</code></pre>
<p>The install script compiles EWW from source (requires Rust), copies all configs, installs the GTK and cursor themes, enables <code>ly@tty1</code>, and configures <code>greetd</code>.</p>
</main>
<footer>
Generated by md-to-html.sh &nbsp;·&nbsp; CyberQueer theme &nbsp;·&nbsp; 2026-05-18
</footer>
</body>
</html>