Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.02 KB

README.md

File metadata and controls

63 lines (44 loc) · 2.02 KB
Raw

sxmo_swaylock

sxmo_swaylock is a fork of swaylock-effects with the touchscreen keypad from swaylock-mobile. This is intended to be used with sxmo on mobile devices, as sxmo currently does not have a proper password protected lockscreen

Features

  • Everything from swaylock-effects (I have not tested that everything works)
  • Support for displaying notifications
  • On screen 10 digit keypad for touchscreens
  • Flat style indicator from swaylock-mobile
  • Customizable indicator length (via --indicator-length)
  • Basic swipe gestures to toggle the keypad (via --swipe-gestures)
  • Battery indicator that replaces the swaylock typing indicator (via --battery-indicator)

Current implementation is not super polished, but in it's current form suffices as a lockscreen and is better than what sxmo has by default.

How to intergrate swaylock into sxmo

Planned Features

  • Smooth animation for the keyboard swipe
  • More presise swipe gesture detection + more swipe gestures
  • Indicator modules (weather, etc)
  • Maybe a full keyboard instead of just the numbered keypad
  • More customization in regards to the keypad

Installation

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.