← back

fork/wpaperd

git clone https://git.julia.blue/fork/wpaperd

Danilo SpinellaRelease version 0.2.089f32c9

0.2.0
3 folders8 files

files

.github/workflows/
man/
src/
.gitignore33 B
CHANGELOG.md485 B
Cargo.lock41.1 KiB
Cargo.toml1.5 KiB
LICENSE.md34.1 KiB
README.md4.1 KiB
build.rs1.0 KiB
install.yml346 B

wpaperd

GitHub release (latest by date) GitHub license GitHub Workflow Status

wpaperd is a minimal wallpaper daemon for Wayland. It allows the user to choose a different image for each output (aka for each monitor) just as swaybg. Moreover, a directory can be chosen and wpaperd will randomly choose an image from it. Optionally, the user can set a duration, after which the image displayed will be changed with another random one.

Features

Getting started

Dependencies

wpaperd is written entirely in Rust and, other than the crates it depends on, it has the following dependencies:

It does not depend on wayland-client C library, but it instead uses a Rust implementation.

Build

To install wpaperd, clone the repository and build the project:

$ git clone https://github.com/danyspin97/wpaperd
$ cd wpaperd
$ cargo build --release

Install

You can install wpaperd using cargo:

$ cargo install --path="."

Otherwise you can install it using rinstall:

# First generate the man page
$ scdoc < man/wpaperd-output.5.scd > man/wpaperd-output.5
$ rinstall -y

To run it, execute the wpaperd program:

$ wpaperd

If you want to automatically run it at startup, add this line to your sway configuration (located in $HOME/.config/sway/config) depending on your installation method:

# For installation using cargo
exec ~/.cargo/bin/wpaperd
# For installation using rinstall
exec ~/.local/bin/wpaperd

Images format support

wpaperd relies on the image crate for loading and dislaying images. By default it supports for the following formats:

Optionally, support for avif images can be enabled by adding its respective feature:

$ cargo build --release --features avif

Output Configuration

The output configuration file for wpaperd is located in XDG_CONFIG_HOME/wpaperd/output.conf (which defaults to $HOME/.config/wpaperd/output.conf) and is a TOML file. Each section represents a different output and contains the following keys:

The section default will be used as fallback for the all the outputs that aren't listed in the config file. This is an example configuration:

[default]
path = "/home/danyspin97/Pictures/Wallpapers/"
duration = "30m"

[eDP-1]
path = "/home/danyspin97/Pictures/Wallpapers/github_octupus.png"
apply-shadow = true

If you're running sway, you can look for the available outputs and their ID by running:

$ swaymsg -t get_outputs

Every time you update the configuration while the program is running, the changes will be applied automatically.

TODO

wpaperd is still a work in progress. The next things to do, in order, are:

License

wpaperd is licensed under the GPL-3.0+ license.