mirror of
https://github.com/AlexMacocian/quick-visor.git
synced 2026-07-15 15:09:32 +00:00
66 lines
1.1 KiB
Markdown
66 lines
1.1 KiB
Markdown
# quick-visor
|
|
|
|
A Quickshell-based display manager overlay for Hyprland.
|
|
|
|
## Usage
|
|
|
|
Install from the AUR:
|
|
|
|
```sh
|
|
paru -S quick-visor
|
|
```
|
|
|
|
Start the resident Quickshell instance once per session:
|
|
|
|
```conf
|
|
exec-once = quick-visor
|
|
```
|
|
|
|
Bind a key to toggle the overlay:
|
|
|
|
```conf
|
|
bind = SUPER, M, exec, quick-visor-toggle
|
|
```
|
|
|
|
For local development, run directly from the clone:
|
|
|
|
```sh
|
|
quickshell -n -p qml/shell.qml
|
|
quickshell ipc -p qml/shell.qml call quick-visor toggle
|
|
```
|
|
|
|
## Configuration
|
|
|
|
`~/.config/quick-visor/config.json` controls panel dimensions. Missing keys fall
|
|
back to built-in defaults, so the file can be omitted.
|
|
|
|
```json
|
|
{
|
|
"panelWidth": 760,
|
|
"panelHeight": 520
|
|
}
|
|
```
|
|
|
|
## Theming
|
|
|
|
`~/.config/quick-visor/theme.jsonc` controls fonts and colors. It supports JSONC
|
|
comments and reloads while quick-visor is running.
|
|
|
|
```jsonc
|
|
{
|
|
"fontFamily": "JetBrainsMono Nerd Font",
|
|
"fontSize": 14,
|
|
"background": "#101010",
|
|
"foreground": "#e6e6e6",
|
|
"idle": "#9a9a9a",
|
|
"accent": "#7aa2f7",
|
|
"warning": "#f7768e",
|
|
"overlayStrong": "#26344d",
|
|
"overlayWeak": "#202020",
|
|
"border": "#3a3a3a",
|
|
"padding": 8,
|
|
"spacing": 8,
|
|
"radius": 12
|
|
}
|
|
```
|