wallr

wallpaper engine for wayland, with gpu transitions, gif and video playback, and optional theme updates.

install

cargo install wallr

this installs the wallr client and wallr-daemon. release archives include both binaries. arch users can install wallr-bin from the aur; nix users can run nix run github:programmersd21/wallr.

use

wallr set wallpaper.jpg
wallr set wallpaper.jpg -e grow -o center -d 850ms
wallr set video.mp4 --fps 30
wallr ipc status

wallr set starts the daemon when daemon.auto_start is enabled. to run it manually, use wallr daemon or start wallr-daemon directly. see the cli reference.

configuration

the default file is ~/.config/wallr/config.yaml:

wallpaper:
  mode: fill
  loop_video: true

theme:
  provider: matugen

daemon:
  auto_start: true
  max_fps: 60

see the configuration reference for all options.

requirements

• a wayland compositor with wlr-layer-shell
• rust 1.90 or newer and FFmpeg development libraries for dynamic source builds; static builds also need the Linux tools listed by scripts/install-static-ffmpeg.sh
• no ffmpeg runtime install for the official static release binaries

build

git clone https://github.com/programmersd21/wallr.git
cd wallr
cargo build --workspace --release --locked

For a static FFmpeg build, run ./scripts/install-static-ffmpeg.sh, then export the variables and run the build command it prints.

more setup and project conventions are in contributing.

documentation

cli · configuration · effects · video · compositors · architecture · benchmarks · changelog

license

MIT. See LICENSE.