hyprlock

Hyprland's simple, yet multi-threaded and GPU-accelerated screen locking utility.

Note

This is a fork of hyprwm/hyprlock. The ratty branch carries the changes below on top of the latest upstream release tag; everything else is upstream.

Configurable fingerprint messages. Upstream only lets you set ready_message and present_message; the rest of what $FPRINTPROMPT and $FPRINTFAIL show is hardcoded. These auth:fingerprint options cover it, each defaulting to upstream's wording (so an unchanged config behaves the same). Labels take Pango markup, so any of them can be an icon instead of text.

Option	Shown in	When
retry_message	$FPRINTPROMPT	scanning again after a finger didn't match
retry_scan_message	$FPRINTPROMPT	the reader asks for another scan
swipe_too_short_message	$FPRINTPROMPT	swipe readers: swipe too short
not_centered_message	$FPRINTPROMPT	finger not centered
remove_and_retry_message	$FPRINTPROMPT	lift the finger and try again
no_match_message	$FPRINTFAIL	a finger didn't match
max_tries_message	$FPRINTFAIL	fingerprint disabled after too many failures
unknown_error_message	$FPRINTFAIL	fingerprint disabled by a reader error
restart_failed_message	$FPRINTFAIL	fingerprint disabled: scanning couldn't restart
disconnected_message	$FPRINTFAIL	fingerprint disabled: reader disconnected
disabled_message	$FPRINTPROMPT	once fingerprint is disabled for any of the above reasons; empty (the default) keeps the last prompt, as upstream does

Fingerprint state for images. $FPRINTSTATE is a fixed keyword for the fingerprint reader's state: none (not running), ready, present (a finger is on the reader), retry (scanning again after a mismatch), hint (the reader asked for another scan) or disabled. An image widget's path can now use variables, and follows them as they change, so it can show one image per state:

image {
    path = ~/.config/hypr/fingerprint-$FPRINTSTATE.png
    size = 48
    rounding = 0
    border_size = 0
}

A state without an image file keeps showing the previous one. Images stay PNG/JPEG/WebP: hyprlock still can't render SVG image widgets.

Shaking images. An image widget with shake_on_fail = fingerprint does a quick side-to-side shake whenever a fingerprint scan fails (password for a wrong password, any for both). Empty, the default, never shakes.

Features

• Uses the ext-session-lock protocol
• Support for fractional-scale
• Fully GPU accelerated
• Multi-threaded resource acquisition
• Blurred screenshot as the background
• Native fingerprint support (using libfprint's dbus interface)
• Some of Hyprland's eyecandy: gradient borders, blur, animations, shadows, etc.
• and more...

How it looks

Docs / Configuration

See the wiki

Arch install

pacman -S hyprlock # binary x86 tagged release
# or
yay -S hyprlock-git # compiles from latest source

Building

Deps

You need the following dependencies

• cairo
• hyprgraphics
• hyprlang
• hyprutils
• hyprwayland-scanner
• mesa (required is libgbm, libdrm and the opengl runtime)
• pam
• pango
• sdbus-cpp (>= 2.0.0)
• wayland-client
• wayland-protocols
• xkbcommon

Sometimes distro packages are missing required development files. Such distros usually offer development versions of library package - commonly suffixed with -devel or -dev.

Building

Building:

cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -S . -B ./build
cmake --build ./build --config Release --target hyprlock -j`nproc 2>/dev/null || getconf _NPROCESSORS_CONF`

Installation:

sudo cmake --install build