Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativecodecat/multimonitorlock
:lock: i3lock wrapper with multi-monitor support
https://github.com/creativecodecat/multimonitorlock
Last synced: 1 day ago
JSON representation
:lock: i3lock wrapper with multi-monitor support
- Host: GitHub
- URL: https://github.com/creativecodecat/multimonitorlock
- Owner: CreativeCodeCat
- License: gpl-3.0
- Created: 2020-05-30T16:58:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-20T14:29:28.000Z (over 3 years ago)
- Last Synced: 2025-01-08T05:16:29.800Z (7 days ago)
- Language: Shell
- Homepage:
- Size: 85.9 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# multimonitorlock
[About](#about) [Features](#features) [Requirements](#requirements) [Install](#install) [Usage](#usage) [Examples](#examples) [Configuration](#configuration) [Issues](#issues) [Contributing](#contributing) [Tips](#tips) [License](#license)
### About
`multimonitorlock` is a wrapper script for `i3lock-color`. It allows you to cache background images for `i3lock-color` with a variety of different effects and adds a stylish indicator.
Originally a fork of [betterlockscreen](https://github.com/pavanjadhaw/betterlockscreen) with support for multiple monitors, `multimonitorlock` has grown considerably. There are a tons of new and useful features.
### Features
- Support for multiple monitors with almost any layout
- Support for HiDPI monitors
- A bunch of cool image effects
- Apply one effect, all effects, or anything in between
- A stylish, themeable indicator
- Set desktop wallpaper to match
### Requirements
- [i3lock-color](https://github.com/PandorasFox/i3lock-color) - i3lock fork with additional features
- [imagemagick](https://www.imagemagick.org/) - Image effects
- [xrandr](https://www.x.org/) - Display info
- [xdpyinfo](https://www.x.org/) - Display info & HiDPI support
- [multimonitorlock-gui](https://github.com/The-Repo-Club/multimonitorlock-gui) - Set background
### Install
##### Manual Installation
```bash
git clone https://github.com/The-Repo-Club/multimonitorlock
cd multimonitorlock
sudo install -Dm 755 multimonitorlock /usr/local/bin/multimonitorlock
```
##### Arch Linux (AUR)
```bash
git clone https://aur.archlinux.org/multimonitorlock.git
cd multimonitorlock-git
less PKGBUILD
makepkg -si
```
### Usage
```bash
Usage: multimonitorlock [-u ] [-l ] [-w ]
-u --update
Update lock screen image
-l --lock
Lock screen with cached image
(Could be use alongside --suspend to show lock screen after waking up from suspend)
-s --suspend
Suspend the system
(Could be use alongside --lock to show lock screen after waking up from suspend)
-w --wall
Set wallpaper with cached image
Additional arguments:
--display
Set display to draw loginbox
--span
Scale image to span multiple displays
--off
Turn display off after N minutes
--fx
List of effects to apply
--
Pass following arguments to i3lock
Effects arguments:
--dim
Dim image N percent (0-100)
--blur
Blur image N amount (0.0-1.0)
--pixel
Pixelate image with N shrink and N grow (unsupported)
--color
Solid color background with HEX
```
### Examples
Update image cache with random image
`multimonitorlock --update ~/Wallpapers`
Update image cache with only dim and pixel effects
`multimonitorlock -u ~/Wallpapers/image.png --fx dim,pixel`
Update image cache with multiple monitors, spanning
`multimonitorlock -u ~/Wallpapers/Dual/ --fx dimblur,color --display 1 --span`
Update image cache with solid background only (ignore errors)
`multimonitorlock -u . --fx color --color 5833ff`
Update image cache with different background images
`multimonitorlock -u ~/Wallpapers/image1.png -u ~/Wallpapers/image2.png --fx dimpixel --display 1`
Lock screen with blur effect
`multimonitorlock --lock blur`
Lock screen with multiple monitors, spanning
`multimonitorlock -l dimblur --display 1 --span`
### Configuration
Copy the example config to `~/.config/multilock/config`
```ini
# 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
# theme options
loginbox=00000066
loginshadow=00000000
locktext="Type password to unlock..."
font="sans-serif"
ringcolor=ffffffff
insidecolor=00000000
separatorcolor=00000000
ringvercolor=ffffffff
insidevercolor=00000000
ringwrongcolor=ffffffff
insidewrongcolor=d23c3dff
keyhlcolor=d23c3dff
bshlcolor=d23c3dff
verifcolor=ffffffff
timecolor=ffffffff
datecolor=ffffffff
```
### Issues
Feel free to open an Issue if you need help or have any question.
Before doing so, please look at both open and closed Issues to see if the issue has already been reported or solved.
Provide details. When submitting an issue, please give the exact command you trying to run. If you are using the config file, post that as well. Problems with `--update`, provide `convert --version` output. Problems with `--lock`, provide `i3lock --version` output.
### Contributing
Pull Requests are weclome! Please try to keep PRs as simple as possible. Add one feature, fix one issue, etc. The easier they are to review, the faster they get merged.
Please try stick with the format of the files (tabs, spacing, etc.). Don't make any "while I'm here" edits. And please document where appropriate.
New to Pull Requests? I suggest this [Pull Request Etiquette](https://gist.github.com/mikepea/863f63d6e37281e329f8) gist.
### Tips
Do not use systemd service. `xautolock` is recommended instead
```bash
# .xinitrc
xautolock -time 10 -locker 'multimonitorlock -l -- --timestr="%H:%M"' &
```
### License
multimonitorlock is under [GPL](https://github.com/The-Repo-Club/multimonitorlock/blob/multi-monitor/LICENSE) license