Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
fyodordev committed May 12, 2023
1 parent 68767b2 commit 148686f
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,42 @@
swaybg-spread
=============

A CLI tool to set a wallpaper spanning over multiple monitors in sway.
A simple CLI tool to set wallpapers spanning over multiple monitors in sway.

It uses the Wayland output configuration to determine monitor size and position, and splits the provided image into separate images for each monitor. These are saved to `~/.cache` by default. It then uses `swaybg` to set the images on the corresponding monitors. To persist the changes the program outputs sway configuration lines which can be written to a sway configuration file.



Originally forked off of [0xk1f0/rwpspread](https://github.com/0xk1f0/rwpspread)

Installation
------------

Available from the [AUR](https://aur.archlinux.org/packages/swaybg-spread):

```bash
yay -S swaybg-spread
```

Usage
-----

Set wallpaper and write it to a sway configuration file to persist sway reloads (The file is imported in the main sway configuration file with `include ~/.config/sway/config.d/*`):
Set wallpaper spanning all monitors once:

```bash
swaybg-spread -i ~/some-wallpaper.jpg
```

Set wallpaper and write it to a sway configuration file to persist sway reloads (In this example the file is imported in the main sway configuration file with `include ~/.config/sway/config.d/*`):

```bash
swaybg-spread -i ~/.theme/active/wallpaper.jpg > ~/.config/sway/config.d/bg.conf
swaybg-spread -i ~/some-wallpaper.jpg > ~/.config/sway/config.d/bg.conf
```

Use custom location for saving image fragments:

```bash
swaybg-spread -i ~/.theme/active/wallpaper.jpg -o ~/.theme/fragments > ~/.config/sway/config.d/bg.conf
swaybg-spread -i ~/some-wallpaper.jpg -o ~/.theme/fragments > ~/.config/sway/config.d/bg.conf
```


Expand Down

0 comments on commit 148686f

Please sign in to comment.