Krolyxon
Commit fcad7df

Branches

Refs →

auroraREADME.md

100 lines · 5.5 KB · Markdown

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