Krolyxon
Commit c531183

Branches

Refs →

auroraREADME.md

103 lines · 5.7 KB · Markdown

1<div align="center">
2 <img src="assets/logo.svg" width="320" alt="aurora">
3 <p>My Arch Linux + Hyprland desktop, in a Nothing OS style, themed live from the wallpaper.</p>
4</div>
5
6![aurora desktop](assets/aurora-desktop.webp)
7
8My desktop: **Arch Linux + Hyprland** (Lua config) + **aurora**, a custom Quickshell shell (bar, panel,
9notifications, OSD, dock), themed live from the wallpaper with **matugen** and deployed with **GNU stow**.
10
11## aurora
12One shell instead of waybar, dunst, wlogout, fuzzel and a pile of scripts, in a Nothing OS style (Doto dot-matrix type,
13pills, LED dots; after [glyph-rice](https://github.com/Nebelung-cloud/glyph-rice)) with Material You colours: everything
14below is themed from the current wallpaper, which aurora draws itself as mono dots, colour dots or the plain photo.
15
16<table>
17 <tr>
18 <td width="50%"><img src="assets/aurora-panel.webp" alt="control panel"><br>
19 <sub><b>Control panel</b> · media, volume/mic/brightness, quick toggles, capture, session</sub></td>
20 <td width="50%"><img src="assets/aurora-panel-sys.webp" alt="system tab"><br>
21 <sub><b>System</b> · cpu, memory, disks, battery, power profile, GPU mode (envycontrol)</sub></td>
22 </tr>
23 <tr>
24 <td><img src="assets/aurora-runner.webp" alt="runner"><br>
25 <sub><b>Runner</b> (<kbd>Super</kbd>+<kbd>R</kbd>) · apps, scripts, calc, shell; also a dmenu for scripts</sub></td>
26 <td><img src="assets/aurora-wallpicker.webp" alt="wallpaper picker"><br>
27 <sub><b>Wallpaper picker</b> · live full-screen preview, folders, search, vim keys, three looks; re-themes everything through matugen</sub></td>
28 </tr>
29 <tr>
30 <td><img src="assets/aurora-chars.webp" alt="glyph picker"><br>
31 <sub><b>Glyph picker</b> (<kbd>Super</kbd>+<kbd>`</kbd>) · emoji, nerd icons, symbols, kaomoji, fancy text</sub></td>
32 <td><img src="assets/aurora-power.webp" alt="power menu"><br>
33 <sub><b>Power menu</b> (<kbd>Super</kbd>+<kbd>Esc</kbd>) · lock, logout, suspend, reboot, ...</sub></td>
34 </tr>
35 <tr>
36 <td><img src="assets/aurora-cal.webp" alt="calendar"><br>
37 <sub><b>Calendar</b> · from the clock in the bar</sub></td>
38 <td><img src="assets/aurora-settings.webp" alt="settings app"><br>
39 <sub><b>Settings</b> (<kbd>Super</kbd>+<kbd>I</kbd>) · network, sound, appearance, Hyprland, keybinds, display, power</sub></td>
40 </tr>
41 <tr>
42 <td colspan="2"><img src="assets/aurora-overview.webp" alt="overview"><br>
43 <sub><b>Overview</b> · live previews of every workspace and window, click to jump</sub></td>
44 </tr>
45</table>
46
47> [!WARNING]
48> **This is my personal setup, not a general purpose dotfiles framework.**
49>
50> It's built around my hardware (Lenovo Legion, Intel + NVIDIA hybrid graphics, `linux-zen`), my monitors,
51> my keyboard and my habits. I'm not trying to make it work for everyone, and I won't be adding options
52> or support for other setups. It's public as a **reference**, or for people who want **exactly the same
53> setup** as me.
54>
55> **Only run `install.sh` on a freshly installed, unconfigured Arch Linux system.** It installs a lot of
56> packages (NVIDIA drivers included if you pick them), replaces your configs with symlinks, changes your login
57> shell and can enable system services. Don't run it on a system you already use.
58
59## Installing (fresh Arch only)
60```bash
61git clone https://git.krolyxon.com/dotfiles ~/.dotfiles
62cd ~/.dotfiles
63./install.sh # interactive: pick packages per group
64./install.sh --yes # pre-select the default packages, no pickers
65./install.sh --check # only compare installed packages with the lists, changes nothing
66```
67The repo has to live at `~/.dotfiles` (stow links into the parent directory).
68
69## Packages
70The lists live in `packages/*.txt`: one package per line, `#` for comments, and a trailing `!` means
71"listed, but not pre-selected".
72
73| file | |
74|---|---|
75| `desktop.txt` | always installed: Hyprland, Quickshell, PipeWire, the tools the shell and keybinds call |
76| `utils.txt` | CLI tools, fonts, media, small utilities |
77| `dev.txt` | development tools |
78| `gpu.txt` | Intel + NVIDIA (`nvidia-open-dkms`) drivers. Change this for your hardware |
79| `optional.txt` | desktop apps |
80| `aur.txt` | AUR packages (installed with paru) |
81| `base.txt` | reference only, never installed: what the base install already provides |
82
83## What's inside
84| | |
85|---|---|
86| WM | Hyprland (Lua config), hypridle, hyprlock; aurora draws the wallpaper (mono dots, colour dots or photo) |
87| Shell / bar | aurora (Quickshell) |
88| Theming | matugen: picking a wallpaper in aurora (or `setwall`) re-themes everything (GTK via adw-gtk3, Qt via qt6ct); accent = the wallpaper's own colour, near-black surfaces. The terminal (foot) too, with ANSI colours tinted toward the wallpaper |
89| Terminal / shell | foot, zsh |
90| Editor | Neovim (LazyVim) |
91| Launcher / menus | aurora's runner (`aurora-run`, also a dmenu replacement for scripts) |
92| Files | lf, pcmanfm |
93| Music / video | mpd + ncmpcpp, mpv |
94| Font / icons | Doto, Space Grotesk, Space Mono (shell UI, vendored in `.local/share/fonts/glyph`), JetBrainsMono Nerd Font, Papirus-Dark |
95
96## Credits
97- aurora's look follows Nothing OS via [glyph-rice](https://github.com/Nebelung-cloud/glyph-rice) by Nebelung-cloud
98 (GPL-3.0): the design language, the dot-matrix shaders (`.config/quickshell/aurora/shaders/`) and several components
99 are ported from it; ported files say so in their header. Nothing, Nothing OS and Glyph are trademarks of Nothing
100 Technology Ltd; this is a fan setup, not affiliated with Nothing.
101- Fonts in `.local/share/fonts/glyph/`: [Doto](https://github.com/oliverlalan/Doto),
102 [Space Grotesk](https://github.com/floriankarsten/space-grotesk) and [Space Mono](https://github.com/googlefonts/spacemono),
103 under the SIL Open Font License (`OFL.txt` next to them).