neonlock

A cyberpunk screen locker for Wayland compositors. Uses the ext-session-lock-v1 protocol to lock your session with a neon-soaked matrix rain animation, password ring UI, and optional YubiKey (U2F) authentication.

Features

• ext-session-lock-v1 — secure, compositor-level session locking
• Matrix rain — animated katakana/latin rain in cyan, pink, and red
• Password ring — minimal dot-based password indicator with shake-on-fail
• Wallpaper support — PNG wallpapers with dark tint overlay; per-user or system-wide
• YubiKey / U2F — optional FIDO U2F unlock via PAM (pam-u2f)
• Grace period — configurable window where any keypress unlocks instantly
• Multi-output — renders independently on every connected display
• Key repeat — respects compositor repeat rate/delay settings

Dependencies

• Wayland compositor with ext-session-lock-v1 support (Sway, Hyprland, etc.)
• wayland-client, wayland-protocols (>= 1.25)
• cairo, pango (pangocairo)
• libpng
• xkbcommon
• pam
• meson and ninja (build)

Optional

• pam-u2f — for YubiKey authentication

Building

meson setup build
ninja -C build
sudo ninja -C build install

PAM configs are installed to /etc/pam.d/neonlock and /etc/pam.d/neonlock-u2f.

Usage

# Basic lock
neonlock

# With wallpaper
neonlock -w ~/Pictures/wallpaper.png

# With 5-second grace period
neonlock -g 5

Wallpaper search order

1. Path given via -w / --wallpaper (file or directory)
2. ~/.config/neonlock/wallpapers/
3. /usr/share/neonlock/wallpapers/
4. Solid background only

Options

Flag	Description
-w, --wallpaper <path>	Wallpaper image or directory
-g, --grace <seconds>	Grace period (any key unlocks)
-h, --help	Show help
-v, --version	Show version

License

GPL-3.0-or-later