hack3rmann / waywe-rs

Wallpaper engine built for wayland written in Rust.

Blazingly Fast Video Wallpapers in Rust

Highly efficient wallpaper software with no overhead

• waywe stands for 'Wayland Wallpaper Engine'

waywe-demo-lowres.mp4

Warning

• This software is still in development, some major features may be unimplemented.
• This project uses a lot of hardware-dependent code to make it work fast as F.
• Special warning for the ones who concerned about unsafe code in Rust: this project contains a lot of it and built upon it. Of course, to speed up a lot of processing code.

Available Features

1. Image wallpapers in various formats.
2. Video wallpapers in .mp4 (h.264 and h.265 -encoded formats)
3. Configurable transition animations.

Dependencies

1. Modern Linux distribution.
2. wlroots-based Wayland compositor (e.g. Hyprland or Sway).
3. Support for libva hardware acceleration.
4. Support for minor (yet unpopular) Vulkan features:
   • VK_KHR_external_memory_fd
   • VK_EXT_image_drm_format_modifier

Install

Clone the repo

git clone --depth=1 https://github.com/hack3rmann/waywe-rs.git

Build and install

Install both waywe and waywe-daemon.

cd waywe-rs
CARGO_TAREGT_DIR=target cargo install --path waywe
CARGO_TAREGT_DIR=target cargo install --path waywe-daemon

Usage

Start the daemon:

waywe start
# or
waywe-daemon --run-in-background

Then use the waywe cli tool to control daemon's behavior:

waywe video path/to/your/video.mp4
waywe image path/to/your/picture.jpg

Note that it will set the same wallpaper for all currently plugged monitors. You can also specify on which monitor to set wallpaper to with --monitor <NAME> key.

Also, you can create preview image of currently running wallpaper:

waywe preview preview.png

For other handy commands run waywe help.

Configuration

You can configure your transition animations in ~/.config/waywe/config.toml. Default config will be generated if user would not have one.

Default configuration:

[animation]
# Transition duration in milliseconds
duration-milliseconds = 2000
# Animation direction: "in" | "out"
direction = "out"
# Interpolation function: "none" | "ease-in" | "ease-out" | "ease-in-out"
# 
# - "none": f(t) = t
# - "ease-in": f(t) = t**2
# - "ease-out": f(t) = 1 - (1 - t)**2
# - "ease-in-out": f(t) = 3 * x**2 - 2 * x**3
easing = "ease-out"

[animation.center-position]
# Amination circle center position type: "random" | "point" [default="random"]
#
# - "random": center will be picked randomly on screen and `position` parameter will be ignored
# - "point": center position will be at point `position` (see next)
type = "random"
# Exact center position of animation circle, used with `type = "point"`.
# Describes position coordinares in range `-1.0..=1.0`
position = [0.0, 0.0]

# Optional post-proccess effects
[[effects]]
# Convolution filter
type = "convolve"
# Convolution kernel (for example, sharpen filter)
kernel = [0.0, -1.0, 0.0, -1.0, 5.0, -1.0, 0.0, -1.0, 0.0]

[[effects]]
# Fast blur filter
type = "blur"
# Number of downsample passes
n_levels = 4
# Growth rate of blur passes on each downsample step (0 for no growth)
level_multiplier = 2

Troubleshooting

This project is tested only on several machines with Intel or AMD CPUs with integrated graphics running Fedora 42.

Common issues

1. ERROR_FORMAT_NOT_SUPPORTED:
   • try install ffmpeg and libva libraries
   • try update/install your video drivers
2. You have both discrete and integrated graphics:
   • try vainfo | grep Driver - it will show the current driver name.
   • if you are on Intel, set LIBVA_DRIVER_NAME=iHD environment variable before you run the daemon.
   • or for AMD, set LIBVA_DRIVER_NAME=Gallium
   • otherwise set it accordingly with your integrated graphics driver.

Alternatives

There are already tools with quite similar features:

• swww - great tool to use with picture wallpapers.
• swaybg - from the authors of wlroots protocol.
• mpvpaper - play videos with mpv directly on your wallpaper.
• hyprpaper - simplest solution for Hyprland users

Acknowledgments

Special thanks to swww. waywe project is heavily inspired by swww.

Future directions

• Using Wallpaper Engine assets for the future use with waywe.