aditya/betterlockscreen-openrc
1
0
Fork 0
mirror of https://git.adityakumar.xyz/betterlockscreen-openrc.git synced 2024-11-09 10:39:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #275 from pavanjadhaw/next

Browse source 
Stable Release
This commit is contained in:
Basti 2021-08-09 23:12:24 +02:00 committed by GitHub
commit a315d2ea24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 1179 additions and 602 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -1,14 +1,9 @@
# Contributing to betterlockscreen # Contributing to Betterlockscreen
Thanks for taking your time to contribute! Thanks to all the amazing people for all your wonderful PRs, issues and ideas, all contributions are welcome!
First off, any and all contributions are welcome. We are using [next](https://github.com/pavanjadhaw/betterlockscreen/tree/next) as our development-branch and master for the latest stable release. Please provide your pull-requests based on our next-branch.
Secondly, if your pull request or issue is in any way related to the [AUR package](https://aur.archlinux.org/packages/betterlockscreen-git/), For Nix-Users: We provide a nix-shell for development :-)
please notify the maintainer @Maik93 via a mention (like used here with the @) in your comment.
Also, in case of adding new dependencies, please notify @Maik93 and @m1m3-50.
For nix-users: We include a nix-shell for development :-)
Thanks Thanks

20
LICENSE
View file

@ -1,21 +1,9 @@
MIT License MIT License
Copyright (c) 2017 Pavan Jadhaw Copyright (c) 2017-2021 Pavan Jadhaw, and others (https://github.com/pavanjadhaw/betterlockscreen/graphs/contributors)
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

256
README.md
View file

@ -6,6 +6,8 @@
<a href="https://github.com/pavanjadhaw/betterlockscreen/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/pavanjadhaw/betterlockscreen?label=Stable&style=for-the-badge"></a> <a href="https://github.com/pavanjadhaw/betterlockscreen/releases"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/pavanjadhaw/betterlockscreen?label=Stable&style=for-the-badge"></a>
<a href="https://github.com/pavanjadhaw/betterlockscreen/actions/workflows/main.yml?query=branch%3Amaster"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/master?label=master&style=for-the-badge"></a> <a href="https://github.com/pavanjadhaw/betterlockscreen/actions/workflows/main.yml?query=branch%3Amaster"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/master?label=master&style=for-the-badge"></a>
<a href="https://github.com/pavanjadhaw/betterlockscreen/actions/workflows/main.yml?query=branch%3Anext"><img alt="GitHub Workflow Status (next)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/next?label=next&style=for-the-badge"></a> <a href="https://github.com/pavanjadhaw/betterlockscreen/actions/workflows/main.yml?query=branch%3Anext"><img alt="GitHub Workflow Status (next)" src="https://img.shields.io/github/workflow/status/pavanjadhaw/betterlockscreen/Main/next?label=next&style=for-the-badge"></a>
<a href="https://github.com/pavanjadhaw/betterlockscreen/milestone/²"><img alt="GitHub milestone" src="https://img.shields.io/github/milestones/progress/pavanjadhaw/betterlockscreen/2?style=for-the-badge"></a>
<a href="https://github.com/pavanjadhaw/betterlockscreen/compare/v4.0.0...next"><img alt="GitHub commits since latest release (by date) for a branch" src="https://img.shields.io/github/commits-since/pavanjadhaw/betterlockscreen/v4.0.0/next?style=for-the-badge"></a>
<a href="https://github.com/pavanjadhaw/betterlockscreen/blob/master/LICENSE"><img src="https://img.shields.io/github/license/pavanjadhaw/betterlockscreen.svg?style=for-the-badge"></a> <a href="https://github.com/pavanjadhaw/betterlockscreen/blob/master/LICENSE"><img src="https://img.shields.io/github/license/pavanjadhaw/betterlockscreen.svg?style=for-the-badge"></a>
</div> </div>
@ -23,97 +25,100 @@
## Table of Contents ## Table of Contents
- [about](#about) - [About](#about)
- [how it works](#how-it-works) - [How it works](#how-it-works)
- [requirements](#requirements) - [System Requirements](#system-requirements)
- [installation](#installation) - [Installation](#installation)
- [configuration](#configuration) - [Configuration](#configuration)
- [usage](#usage) - [Usage](#usage)
- [background](#set-desktop-background-on-startup) - [Background](#background)
- [keybinding](#keybindings) - [Keybinding](#keybindings)
- [lockscreen on suspend](#lockscreen-when-suspendedsystemd-service) - [Lockscreen on sleep/suspend with systemd](#systemd)
### About ## About
Most of i3lock wrapper scripts out there takes an image, adds some effect and locks the screen Most of i3lock wrapper-scripts out there take an image, add some effect(s) then lock with the modified image as locker-background. Overall experience doesn't feel natural given delay of 2-3 seconds.
adding effects, overall experience doesn't feel natural given delay of 2-3 seconds.
Who would like a delay of 2-3 seconds while locking screen?
So betterlockscreen was my attempt to solve this problem, as we dont need to change lockscreen background frequently > Who would like a delay of 2-3 seconds while locking screen?
this script caches images with effect so overall experience is simple and as fast as native i3lock.
### How it works So Betterlockscreen was my attempt to solve this problem, as we dont need to change lockscreen background frequently this script caches images with effect so overall experience is simple and as fast as native i3lock.
The script takes image adds various effects and caches those images in special directory and then uses those ## How it works
images as lockscreen background depending on argument provided by user.
### Requirements The script takes a directory or image, adds various effects and caches the images in special directory. Those cached images will be used as locker-background depending on configuration provided by user.
## System Requirements
* [i3lock-color](https://github.com/Raymo111/i3lock-color) `>= 2.13.c.3`
* [ImageMagick](https://imagemagick.org/)
* xdpyinfo, xrandr, xrdb and xset from [X.Org](https://www.x.org/)
* (Optional) [Dunst](https://dunst-project.org/)
* (Optional) [feh](https://feh.finalrewind.org/) for wallpaper-functionality
> Note: Make sure your system has all dependencies satisfied > Note: Make sure your system has all dependencies satisfied
- [i3lock-color](https://github.com/Raymo111/i3lock-color) - i3lock fork with additional features(`>= 2.13.c.3`) ## Installation
- [imagemagick](https://www.imagemagick.org/script/index.php) - To apply effects to images
- [xdpyinfo](https://www.x.org/archive/X11R7.7/doc/man/man1/xdpyinfo.1.xhtml), [xrandr](https://www.x.org/wiki/Projects/XRandR/), [bc](https://www.gnu.org/software/bc/) and [feh](https://feh.finalrewind.org/) - To find screen resolution, set custom blur level and wallpaper handling.
### Installation
> manual installation
```sh
git clone https://github.com/pavanjadhaw/betterlockscreen
cd betterlockscreen
cp betterlockscreen ~/.local/bin/
```
<p style="text-align: center">OR</p>
```sh
# or wget the script ~12KB
wget -O betterlockscreen https://git.io/fASUJ
chmod u+x betterlockscreen
cp betterlockscreen ~/.local/bin/
```
```sh
# Add betterlockscreen to PATH:
# (In your .bashrc, .zshrc etc)
export PATH="${PATH}:${HOME}/.local/bin/"
```
### Package Manager ### Package Manager
#### Arch Linux <a href="https://repology.org/project/betterlockscreen">
<img src="https://repology.org/badge/vertical-allrepos/betterlockscreen.svg" alt="Packaging status" align="right">
</a>
###### Installing dependencies(not required if using betterlockscreen aur package) Betterlockscreen is available via package manager on some linux-distributions, if you miss your favorite one you can follow along with our [installation-script](#installation-script) or [manual-installation](#manual-installation).
`pacman -S imagemagick feh xorg-xrandr xorg-xdpyinfo` If you are using **Arch Linux**, you can install the AUR package
[betterlockscreen](https://aur.archlinux.org/packages/betterlockscreen/) to get the latest
version, or [betterlockscreen-git](https://aur.archlinux.org/packages/betterlockscreen-git/) for the most up-to-date (unstable) changes.
- i3lock-color - `trizen -S i3lock-color` If you are using **Gentoo Linux**, you can install `betterlockscreen` from Gentoo's [GURU overlay](https://wiki.gentoo.org/wiki/Project:GURU) using `emerge x11-misc/betterlockscreen`.
#### Aur package If you are using **NixOS**, [betterlockscreen](https://search.nixos.org/packages?query=betterlockscreen) is available in both the [stable](https://github.com/NixOS/nixpkgs/blob/nixos-21.05/pkgs/misc/screensavers/betterlockscreen/default.nix) and [unstable](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/misc/screensavers/betterlockscreen/default.nix) channels and can be installed using `nix-env -iA nixos.betterlockscreen`.
`betterlockscreen` is available in the Arch User repos as `betterlockscreen` and `betterlockscreen-git`. If you are using **Void Linux**, you can install [betterlockscreen](https://github.com/void-linux/void-packages/blob/master/srcpkgs/betterlockscreen/template) using `xbps-install -S betterlockscreen`.
- betterlockscreen - `trizen -S betterlockscreen` ### Installation Script
- betterlockscreen-git - `trizen -S betterlockscreen-git`
#### Debian and derivatives We have created an automatic [install-script](https://github.com/pavanjadhaw/betterlockscreen/blob/master/install.sh) for Betterlockscreen. The script is very simple and takes three parameters:
* `<install-mode>`: (string) 'user' installs to '~/.local/bin/', 'system' installs to '/usr/local/bin'
* `[<version>]`: (string) defaults to 'latest' which will determinate the latest tag from git or specified branch/tag
* `[<systemd-service>]`: (boolean) defaults to 'false' - Whether to copy and enable system-service.
UtkarshVerma was so kind to provide an installation script for debian based systems, ![check it out here](https://github.com/UtkarshVerma/installer-scripts). For system-installation:
```sh
wget https://git.io/JZyxV -O - -q | bash -- system
```
#### Void Linux For user-installation:
```sh
wget https://git.io/JZyxV -O - -q | bash -- user
```
##### xbps repository Please note: The [git.io](https://git.io/)-URL is just a short-url for the [master/install.sh](https://raw.githubusercontent.com/pavanjadhaw/betterlockscreen/master/install.sh).
`betterlockscreen` is available in official Void's repository as `betterlockscreen`. ### Manual Installation
Installing using `xbps` (will automatically install all required dependencies): `xbps-install -S betterlockscreen` Ỳou can download the latest release [here](https://github.com/pavanjadhaw/betterlockscreen/releases), please ensure to fullfill the [system-requirements](#system-requirements)!
### Configuration You will need to copy "betterlockscreen" to you desired binary-directory, if you want to use the systemd-service you will need to copy the service-file from "system/" to the desired location on your system.
You can customise various colors for betterlockscreen, copy config file from examples directory to `~/.config/betterlockscreenrc` and edit it accordingly. Example (Ubuntu):
```sh
wget https://github.com/pavanjadhaw/betterlockscreen/archive/refs/heads/master.zip
unzip master.zip
If configuration file is not found then default configurations will be used. cd betterlockscreen-master/
chmod u+x betterlockscreen
cp betterlockscreen /usr/local/bin/
cp system/betterlockscreen@.service /usr/lib/systemd/system/
systemctl enable betterlockscreen@$USER
```
## Configuration
You can customize betterlockscreen for your needs, copy the config file from the examples-directory to `~/.config/betterlockscreenrc` and edit it accordingly.
If no configuration-file is found, then the default configurations (which is equal to the example but currently hardcoded) will be used.
If you have installed betterlockscreen from AUR package, then you can copy default config from docs If you have installed betterlockscreen from AUR package, then you can copy default config from docs
@ -121,63 +126,79 @@ If you have installed betterlockscreen from AUR package, then you can copy defau
cp /usr/share/doc/betterlockscreen/examples/betterlockscreenrc ~/.config cp /usr/share/doc/betterlockscreen/examples/betterlockscreenrc ~/.config
``` ```
### Usage ## Usage
Run `betterlockscreen` and point it to either a directory (`betterlockscreen -u "path/to/dir"`) or an image (`betterlockscreen -u "/path/to/img.jpg"`) and that's all. `betterlockscreen` will change update its cache with image you provided. Run `betterlockscreen` and point it to either a directory (`betterlockscreen -u "path/to/dir"`) or an image (`betterlockscreen -u "/path/to/img.jpg"`) and that's all. `betterlockscreen` will change update its cache with image you provided.
```sh ```sh
usage: betterlockscreen [-u "path/to/img.jpg"] [-l "dim, blur or dimblur"] Usage: betterlockscreen [-u <PATH>] [-l <EFFECT>] [-w <EFFECT>]
[-w "dim, blur, pixel or dimblur"] [-t "custom text"] [-s "lockscreen and suspend"]
[-r "resolution"] [-b "factor"] [--off <timeout>]
betterlockscreen - faster and sweet looking lockscreen for linux systems. -u --update <PATH>
Update lock screen image
required: -l --lock <EFFECT>
-u, --update "path/to/img.jpg" caches all required images Lock screen with cached image
usage: -w --wall <EFFECT>
-l, --lock effect-name Set wallpaper with cached image
locks with provided effect
-w, --wall effect-name
set desktop background with provided effect
-s, --suspend effect-name
lockscreen and suspend
Available effects: Additional arguments:
dim, blur, pixel or dimblur
-t, --text "custom text" --display <N>
set custom lockscreen text Set display to draw loginbox
-b, blur 0.0 - 1.0
set blur range
-r, --resolution res
uses a custom resolution
--off, --off <timeout>
sets custom monitor timeout (<timeout> in seconds)
--span
Scale image to span multiple displays
Usage examples: --off <N>
1. Updating image cache(required) Turn display off after N minutes
betterlockscreen -u ~/Pictures/Forests.png # caches given image
betterlockscreen -u ~/Pictures # caches random image from ~/Pictures directory
2. Custom resolution and blur range --fx <EFFECT,EFFECT,EFFECT>
betterlockscreen -u path/to/directory -r 1920x1080 -b 0.5 List of effects to apply
3. Lockscreen -- <ARGS>
betterlockscreen -l dim # lockscreen with dim effect Pass following arguments to i3lock
4. Lockscreen with custom text Effects arguments:
betterlockscreen -l pixel -t "custom lockscreen text"
5. Set desktop background --dim <N>
betterlockscreen -w blur # set desktop background with blur effect Dim image N percent (0-100)
6. Lockscreeen with custom monitor off timeout --blur <N>
betterlockscreen --off 5 -l blur # set monitor off lockscreen timeout (5 seconds) Blur image N amount (0.0-1.0)
--pixel <N,N>
Pixelate image with N shrink and N grow (unsupported)
--color <HEX>
Solid color background with HEX
``` ```
### Set desktop background on startup
#### Examples
1. Update image cache with random image
`betterlockscreen -u ~/Wallpapers`
2. Update image cache with only dim and pixel effects
`betterlockscreen -u ~/Wallpapers/image.png --fx dim,pixel`
3. Update image cache with random image, multiple monitors, login on 1, spanning
`betterlockscreen -u ~/Wallpapers/Dual/ --display 1 --span`
4. Update image cache with solid background only (ignore errors)
`betterlockscreen -u . --fx color --color 5833ff`
5. Update image cache with different background images
`betterlockscreen -u ~/Wallpapers/image1.png -u ~/Wallpapers/image2.png`
6. Lock screen with blur effect
`betterlockscreen --lock blur`
7. Lock screen with multiple monitors, spanning
`betterlockscreen -l dimblur --display 1 --span`
## Background
Add this line to `.xinitrc`. Add this line to `.xinitrc`.
@ -189,7 +210,7 @@ betterlockscreen -w dim
source ~/.fehbg source ~/.fehbg
``` ```
#### i3wm ### i3wm
Add this line to `~/.config/i3/config` Add this line to `~/.config/i3/config`
@ -201,11 +222,11 @@ exec --no-startup-id betterlockscreen -w dim
exec --no-startup-id source ~/.fehbg exec --no-startup-id source ~/.fehbg
``` ```
### Keybindings ## Keybindings
To lockscreen using keyboard shortcut To lockscreen using keyboard shortcut
#### i3wm ### i3wm
Add this line to your `~/.config/i3/config` Add this line to your `~/.config/i3/config`
@ -213,7 +234,7 @@ Add this line to your `~/.config/i3/config`
bindsym $mod+shift+x exec betterlockscreen -l dim bindsym $mod+shift+x exec betterlockscreen -l dim
``` ```
#### bspwm ### bspwm
Add this line to your `~/.config/sxhkd/sxhkdrc` Add this line to your `~/.config/sxhkd/sxhkdrc`
@ -223,7 +244,8 @@ alt + shift + x
betterlockscreen -l dim betterlockscreen -l dim
``` ```
### Lockscreen when suspended(systemd service) <h2 id="systemd">Systemd-Service: Lockscreen after sleep/suspend</h2>
```sh ```sh
# move service file to proper dir (the aur package does this for you) # move service file to proper dir (the aur package does this for you)
cp betterlockscreen@.service /usr/lib/systemd/system/ cp betterlockscreen@.service /usr/lib/systemd/system/
@ -247,26 +269,16 @@ Resources and more informations:
--- ---
### Countributing ## Countributing
Thanks to all the amazing people for all your wonderful PRs, issues and ideas! Please see [CONTRIBUTING.md](CONTRIBUTING.md).
[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/0)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/0)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/1)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/1)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/2)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/2)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/3)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/3)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/4)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/4)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/5)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/5)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/6)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/6)[![](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/images/7)](https://sourcerer.io/fame/pavanjadhaw/pavanjadhaw/betterlockscreen/links/7)
## How can I support developers?
- Star our GitHub repo :star:
- Create pull requests, submit bugs, suggest new features or documentation updates :wrench:
## License ## License
Betterlockscreen is under [MIT](https://github.com/pavanjadhaw/betterlockscreen/blob/master/LICENSE) license. Betterlockscreen is under [MIT](https://github.com/pavanjadhaw/betterlockscreen/blob/master/LICENSE) license.
## Feel free to use and distribute ### Feel free to use and distribute
- Hat tip to anyone who's code was used - Hat tip to anyone who's code was used
- Thanks to those who contributed to make it better - Thanks to those who contributed to make it better
- Inspiration - [r/unixporn](https://www.reddit.com/r/unixporn) - Inspiration - [r/unixporn](https://www.reddit.com/r/unixporn)
[logo]: .github/hero.png
[website]: https://mdxjs.com

1206
betterlockscreen
View file

File diff suppressed because it is too large Load diff

45
examples/betterlockscreenrc
View file

@ -1,19 +1,36 @@
# configuration file for betterlockscreen # ~/.config/betterlockscreenrc
insidecolor=00000000 # default options
display_on=0
span_image=false
lock_timeout=300
fx_list=(dim blur dimblur pixel dimpixel color)
dim_level=40
blur_level=1
pixel_scale=10,1000
solid_color=333333
wallpaper_cmd="feh --bg-fill"
# i3lockcolor_bin="i3lock-color" # Manually set command for i3lock-color
# default theme
loginbox=00000066
loginshadow=00000000
locktext="Type password to unlock..."
font="sans-serif"
ringcolor=ffffffff ringcolor=ffffffff
insidecolor=00000000
separatorcolor=00000000
ringvercolor=ffffffff
insidevercolor=00000000
ringwrongcolor=ffffffff
insidewrongcolor=d23c3dff
timecolor=ffffffff
time_format="%H:%M:%S"
greetercolor=ffffffff
layoutcolor=ffffffff
keyhlcolor=d23c3dff keyhlcolor=d23c3dff
bshlcolor=d23c3dff bshlcolor=d23c3dff
separatorcolor=00000000
insidevercolor=00000000
insidewrongcolor=d23c3dff
ringvercolor=ffffffff
ringwrongcolor=ffffffff
verifcolor=ffffffff verifcolor=ffffffff
timecolor=ffffffff wrongcolor=d23c3dff
datecolor=ffffffff modifcolor=d23c3dff
loginbox=00000066 bgcolor=000000ff
font="sans-serif"
locktext='Type password to unlock...'
lock_timeout=5
time_format='%H:%M:%S'

109
install.sh Executable file
View file

@ -0,0 +1,109 @@
#!/usr/bin/env bash
cmd_exists () {
command -v "$1" >/dev/null
}
echof() {
local colorReset="\033[0m"
local prefix="$1"
local message="$2"
case "$prefix" in
header) msgpfx="[\e[1;95mB\e[m]" color="";;
info) msgpfx="[\e[1;97m=\e[m]" color="\033[0;34m";;
act) msgpfx="[\e[1;92m*\e[m]" color="";;
ok) msgpfx="[\e[1;93m+\e[m]" color="\033[0;32m";;
error) msgpfx="[\e[1;91m!\e[m]" color="\033[0;31m";;
*) msgpfx="" color="";;
esac
echo -e "$msgpfx $color $message $colorReset"
}
case $1 in
system)
BL_INSTALL_DIR="/usr/local/bin"
;;
user)
BL_INSTALL_DIR="$HOME/.local/bin"
if [[ ! -d $BL_INSTALL_DIR ]]; then
mkdir -p "$BL_INSTALL_DIR"
fi
;;
*)
echo "Usage: $0 <install-mode> [<version>] [<systemd-service>]"
echo " <install-mode>: (string) 'user' installs to '~/.local/bin/', 'system' installs to '/usr/local/bin'"
echo " <version>: (string) defaults to 'latest' which will determinate the latest tag from git or specified branch/tag"
echo " <systemd-service>: (boolean) defaults to 'false' - Whether to copy and enable system-service"
echo -e "\nPlease note: The order of the parameters *is* relevant, if you want to set '<system-service>' you need to specify '<version>' as well!"
exit 1
;;
esac
echof header "Betterlockscreen-Setup"
if [[ ! -w $BL_INSTALL_DIR ]]; then
echof error "Unable to write to '$BL_INSTALL_DIR'!"
exit 1
fi
echof info "Checking system-requirements..."
declare -A DEPS
DEPS["ImageMagick"]="convert"
DEPS["i3lock-color"]="i3lock-color"
DEPS["xdpyinfo"]="xdpyinfo"
DEPS["xrdb"]="xrdb"
DEPS["xset"]="xset"
if ! cmd_exists DEPS["i3lock-color"] && cmd_exists "i3lock"; then
DEPS["i3lock-color"]="i3lock"
fi
for key in "${!DEPS[@]}"; do
[[ ! -e "$(command -v ${DEPS[$key]})" ]] && echof error "Missing '$key' under binary named '${DEPS[$key]}'!" && exit 1
done
echof ok "done!"
VERSION=$2
if [[ $VERSION == "" ]] || [[ $VERSION == "latest" ]]; then
echof info "Determinate latest release... "
VERSION=$(git describe --tags "$(git rev-list --tags --max-count=1)")
echof ok "done! ($VERSION)"
fi
BLI_TEMP_DIR=$(mktemp -d)
git clone -b "$VERSION" https://github.com/pavanjadhaw/betterlockscreen "$BLI_TEMP_DIR" &>/dev/null
cd "$BLI_TEMP_DIR" || exit 1
echof info "Installing Betterlockscreen to '$BL_INSTALL_DIR'... "
cp betterlockscreen "$BL_INSTALL_DIR"
echof ok "done!"
if [[ $3 == "true" ]]; then
SYSTEMD_SERVICE_DIR="/usr/lib/systemd/system"
echof info "Installing/enable sytemd-service... "
if [[ ! -w $SYSTEMD_SERVICE_DIR ]]; then
echof error "\nUnable to write to '$SYSTEMD_SERVICE_DIR'!"
exit 1
fi
cp system/betterlockscreen@.service $SYSTEMD_SERVICE_DIR
systemctl enable betterlockscreen@"$USER"
echof ok "done!"
fi
if [[ $PATH != *"$BL_INSTALL_DIR"* ]]; then
echof error "Please ensure to add 'export PATH=\"\$PATH:/home/\$USER/.local/bin\"' to your shell-config!\033[0m"
fi
echof ok "Install completed successfully!"
exit 0