https://github.com/System64fumo/syslock

Simple screen locker for wayland written in gtkmm 4
https://github.com/System64fumo/syslock

Last synced: about 1 month ago
JSON representation

Simple screen locker for wayland written in gtkmm 4

• Host: GitHub
• URL: https://github.com/System64fumo/syslock
• Owner: System64fumo
• License: wtfpl
• Created: 2024-05-30T13:44:10.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T15:49:35.000Z (about 2 months ago)
• Last Synced: 2024-10-16T20:03:00.652Z (about 2 months ago)
• Language: C++
• Homepage:
• Size: 3.82 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hyprland - syslock

README

        
# Syslock

Syslock is a simple lockscreen for wayland written in gtkmm4


![preview](https://github.com/System64fumo/syslock/blob/main/preview.gif "preview")

> [!CAUTION]

> This program does not use the ext session lock protocol. *Yet*


> Additional info at the bottom.


# Configuration

syslock can be configured in 2 ways


1: By changing config.hpp and recompiling (Suckless style)


2: Using a config file (~/.config/sys64/lock/config.conf)


3: Using launch arguments


```

arguments:

  -s	Start unlocked

  -k	Enable the keypad

  -l	Set password length (For automatic unlocks)

  -m	Set primary monitor

  -e	Enable experimental session lock

  -d	Enable debug mode

  -v	Prints version info

```

# Signals

You can send a signal to show the window/s again.


``pkill -10 syslock``


# Theming

syslock uses your gtk4 theme by default, However it can be also load custom css,


Just copy the included style.css file to ~/.config/sys64/lock/style.css


# Session lock

Currently the session lock protocol is implemented but disabled by default due to instability and generally being broken.


Though if you are curious and wish to give it a try you can enable it by using the -e launch flag.


Things that will happen when the experimental session lock option is enabled:


* syslock will crash upon succesfully authenticating.


* The primary window gets mirrored to all displays.


* Touch inputs will not work.


Help with this would be greatly appreciated.