Skip to content

Latest commit

 

History

History
113 lines (91 loc) · 5.03 KB

README.md

File metadata and controls

113 lines (91 loc) · 5.03 KB
Raw

swaylock-plugin

This is a fork of swaylock, a screen locking utility for Wayland compositors. With swaylock-plugin, you can for your lockscreen background display the animated output from any wallpaper program that implements the wlr-layer-shell-unstable-v1 protocol. All you have to do is run swaylock-plugin --command 'my-wallpaper ...', where my-wallpaper ... is replaced by your desired program. Examples:

  • swaybg, which displays regular background images
  • mpvpaper, which lets you play videos
  • shaderbg, renders OpenGL shaders
  • rwalkbg, a very slow animation
  • wscreensaver, an experiment in porting a few xscreensaver hacks to Wayland. Best with the --command-each flag.
  • windowtolayer, a tool that can be used to run normally windowed applications, like terminals, as wallpapers. Requires --command-each flag. For example: 
    swaylock-plugin --command-each 'windowtolayer -- termite -e neo-matrix'
swaylock-plugin --command-each 'windowtolayer -- alacritty -e asciiquarium'
  • You can rotate between wallpapers in a folder by setting the following script as the command; e.g.: swaylock-plugin --command './example_rotate.sh /path/to/folder'. (This works by periodically killing the wallpaper program, after which swaylock-plugin automatically restarts it.) 
    #!/bin/sh
file=`ls $1 | shuf -n 1`
delay=60.
echo "Runnning swaybg for $delay secs on: $1/$file"
timeout $delay swaybg -i $1/$file

swaylock-plugin requires that the Wayland compositor implement the ext-session-lock-v1 protocol.

This is experimental software, so if something fails to work it's probably a bug in this program -- report it at https://github.com/mstoeckl/swaylock-plugin .

As this fork is not nearly as well tested as the original swaylock, before using this program, ensure that you can recover from both an unresponsive lockscreen and one that has crashed. (For example, in Sway, by creating a --locked bindsym to kill and restart swaylock-plugin; or by switching to a different virtual terminal, running killall swaylock-plugin and running swaylock-plugin, and restarting with e.g. WAYLAND_DISPLAY=wayland-1 swaylock-plugin .)

See the man page, swaylock-plugin(1), for instructions on using swaylock-plugin.

Grace period

swaylock-plugin adds a grace period feature; unlike the original swaylock, it is not practical to emulate one using a separate program (like chayang) because any animated backgrounds would be interrupted. With the --grace flag, it is possible to unlock the screen without a password for the first few seconds after the screen locker starts with either a key press or significant mouse motion.

This feature requires logind (systemd or elogind) support to automatically end the grace period just before the computer goes to sleep. The grace period also ends on receipt of the signal SIGUSR2.

Example

Sway can be made to lock the screen with a grace period and the custom wallpaper program specified in the script lock-bg-command.sh with the following configuration:

exec swayidle \
    timeout 300 'swaylock-plugin --grace 30sec --pointer-hysteresis 25.0 --command-each lock-bg-command.sh' \
    timeout 600 'swaymsg "output * dpms off"' \
       resume 'swaymsg "output * dpms on"' \
       before-sleep 'swaylock-plugin --command-each lock-bg-command.sh'
bindsym --locked Ctrl+Alt+L exec \
    'killall -SIGUSR2 swaylock-plugin; \
    swaylock-plugin --command-each lock-bg-command.sh'

This will, after 5 minutes of inactivity, start swaylock-plugin; for the next 30 seconds, one can easily unlock the screen by pressing any key or moving the mouse more than 25 pixels in a one second period; afterwards, authentication will be required. When the computer goes to sleep, the screen will lock for certain. (If swaylock-plugin was running and in the grace period, the grace period will end; in case swaylock-plugin was not running, a new instance will be started without a grace period, that locks the screen if it was not already locked.) One can also immediately lock the screen with a keybinding (or use the keybinding to restart the lock screen, if it crashed.) Any screens will be turned off after 10 minutes of inactivity.

Installation

Install dependencies:

  • meson *
  • wayland
  • wayland-protocols *
  • libxkbcommon
  • cairo
  • gdk-pixbuf2
  • pam (optional)
  • systemd or elogind (optional)
  • scdoc (optional: man pages) *
  • git *
  • swaybg

* Compile-time dep

Run these commands:

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

On systems without PAM, you need to suid the swaylock-plugin binary:

sudo chmod a+s /usr/local/bin/swaylock-plugin

Swaylock will drop root permissions shortly after startup.