swaylock-effects

Swaylock-effects is a fork of swaylock which adds built-in screenshots and image manipulation effects like blurring. It's inspired by i3lock-color, although the feature sets aren't perfectly overlapping.

Example Command

swaylock \
	--screenshots \
	--clock \
	--indicator \
	--indicator-radius 100 \
	--indicator-thickness 7 \
	--effect-blur 7x5 \
	--ring-color bb00cc \
	--key-hl-color 880033 \
	--line-color 00000000 \
	--inside-color 00000088 \
	--separator-color 00000000

New Features

The main new features compared to upstream swaylock are:

--screenshots to use screenshots instead of an image on disk or a color
--clock to show date/time in the indicator
- Use --indicator to make the indicator always active
- Use --timestr and --datestr to set the date/time formats (using strftime-style formatting)
Various effects which can be applied to the background image
- --effect-blur <radius>x<times> blurs the image (thanks to yvbbrjdr's fast box blur algorithm in i3lock-fancy-rapid)
- --effect-scale <scale> scales the image by a factor. This can be used to pixelate the image, or make other effects faster if you don't need the full resolution.
- --effect-greyscale makes the image greyscale.

New feature ideas are welcome as issues (though I may never get around to implement them), new feature implementations are welcome as pull requests :)

Installation

From Packages

The swaylock-effects-git package is available for Arch Linux.

Compiling from Source

Install dependencies:

meson *
wayland
wayland-protocols *
libxkbcommon
cairo
gdk-pixbuf2 **
pam (optional)
scdoc (optional: man pages) *
git *
openmp (if using a compiler other than GCC)

*Compile-time dep

**Optional: required for background images other than PNG

Run these commands:

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

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

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

Swaylock will drop root permissions shortly after startup.

yschaeff / swaylock-effects