README.md

 ┏━┓┳  o┏┓┓┏━┓┳ ┳┳  ┏━┓┏━┓┳┏ 
 ┃ ┳┃  ┃ ┃ ┃  ┃━┫┃  ┃ ┃┃  ┣┻┓
 ┇━┛┇━┛┇ ┇ ┗━┛┇ ┻┇━┛┛━┛┗━┛┇ ┛

glitchlock: a glitch art themed randomized lockscreen. powered by swaylock.

table of contents

• about
• how it works
• security
• requirements
• customize
• more
• license

about

i (xero) do glitch art for fun. i was messing around w/ one of my shell scripts and thought: this would make a cool lockscreen! after a bit of research and refactoring here we are.

this fork

this is a fork of the original work by xero and modified to work on Wayland by crablab.

how it works

the script takes a screenshot, then datamoshes it. optionally overlays an image (one for each display) then uses that image as the background for the lockscreen.

security

this lockscreen has the potential for information leakage, since it uses a screenshot of your active screen. i made this for fun and personal use, please take care and weigh your opsec and personal threat model before deciding to use this.

an example workaround would be setting up your screen very nicely w/o any secret info in it and taking a screenshot. then replace line #9 in the script (grim /tmp/lock.png) with a command to {move,copy} your pre-setup screenshot into place (e.g. cp ~/lib/img/lock.png /tmp/lock.png) then let the script randomly glitch that image out everytime.

requirements

• swaylock
  • swaylock is a screen locking utility for Wayland compositors
  • https://github.com/swaywm/swaylock
• grim
  • grab images from a Wayland compositor
  • https://github.com/emersion/grim
• imagemagick
  • image manipulation toolkit
  • https://github.com/ImageMagick/ImageMagick

these are available on aur and apt. mileage on your package manager may vary.

customize

if called alone, the script will take a screenshot and glitch it. but you can optionally pass an environment variable named GLITCHICON to the app and it will center that image on each display and overlay it on the glitched image.

an example of calling the script on MOD4+ESC using sxhkd

# lockscreen
mod4 + Escape
 GLITCHICON=~/src/glitchlock/stop.png ~/bin/glitchlock

more

• https://0w.nz
• https://xero.nu
• https://nixers.net
• https://git.io/.files
• https://reddit.com/r/unixporn

license

Origial licence below. Wayland fork redistributed with the MIT licence (see LICENCE.md). Contains work from swaylock-fancy redistributed under the MIT licence (see LICENCE.md).

kopimi! in the spirit of freedom of information, i encourage you to fork, modify, change, share, or do whatever you like with this project! ^c^v