cherrynoize / n3lock

An opinionated i3-lock based screen locker

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

n3lock

Next gen i3lock-color fork and wrapper

preview

Dependencies

bash imagemagick i3lock-color

Installation

  1. Install the required dependencies
yay -S bash imagemagick i3lock-color
  1. Clone this repo and run make install
git clone https://github.com/cherrynoize/n3lock
cd n3lock
make install

To uninstall simply run

make uninstall

Configuration

n3lock looks for a config file at $HOME/.config/n3lock/config.sh. It's not there by default, you need to create it.

cp config.sh.example "$HOME/.config/n3lock/config.sh"

You can pretty much override any variable defined at the top of n3lock since this file is sourced after initialization.

You could, for instance, source other config modules like so:

. path/to/config.sh

Usage

First cache images with

n3lock -p [PATH/TO/PFP] -w [PATH/TO/WALLPAPER]

From now on you can run n3lock with your cached images like so

n3lock [-c CONFIG]

See usage for more details

n3lock --help

Credits

Contribute

Todo

  • display battery information
  • display proper keyboard input modes
  • add additional greeting messages
  • add powermenu

Testing

You can help the project by just using it and submitting any issue or misbehaviour.

Please consider opening a pull request if you know how to improve some feature or how to fix a bug you found.

Thanks for using n3lock 💙

About

An opinionated i3-lock based screen locker


Languages

Language:Shell 97.3%Language:Makefile 2.7%