Quick Start (5 min)
1) Install
If you are on Arch, the AUR packages are easiest:
yay -S wayscriber
# or
paru -S wayscriber
For other distros, see Installation.
2) Run once
Launch a one shot overlay to confirm it works:
wayscriber --active
Press Escape to exit.
3) Pick a run mode
For daily use, daemon mode is best:
wayscriber --daemon
If you have the user service installed:
systemctl --user enable --now wayscriber.service
4) Add a keybind
Hyprland example:
bind = SUPER, D, exec, pkill -SIGUSR1 wayscriber
Use your compositor settings to bind the same command.
5) Learn the basics
- F1 opens the help overlay (F10 is the alternative)
- F11 opens the configurator (if installed)
- F2 or F9 toggles the toolbars
- Escape or Ctrl+Q exits the overlay