A video wallpaper program for wlroots based wayland compositors.
  • C 97.9%
  • Roff 1.2%
  • Shell 0.5%
  • Meson 0.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
GhostNaN fc5ed285d6 Update man page
* Fix and add new active option to auto-mode
* Fix small typo
2026-08-28 23:51:39 -04:00
inc Format code again 2024-04-25 00:03:36 -04:00
proto Implement auto-mode option with wlr toplevel protocol 2026-07-10 17:07:52 -04:00
scripts Update README.md 2026-07-14 22:31:43 -04:00
src Fix handle egl swap and surface teardown (#138) 2026-08-23 22:11:40 -04:00
LICENSE Initial commit 2020-08-01 23:53:45 +00:00
meson.build Implement auto-mode option with wlr toplevel protocol 2026-07-10 17:07:52 -04:00
mpvpaper.man Update man page 2026-08-28 23:51:39 -04:00
README.md Update README.md 2026-07-14 22:23:12 -04:00

Preview

mpvpaper

mpvpaper is a wallpaper program for wlroots based wayland compositors, such as sway. That allows you to play videos with mpv as your wallpaper.

Dependencies

Building

Building Requirements:

  • ninja
  • meson
  • libmpv

Clone | Build | Install:

# Clone
git clone --single-branch https://github.com/GhostNaN/mpvpaper
# Build
cd mpvpaper
meson setup build --prefix=/usr/local
ninja -C build
# Install
ninja -C build install

Usage

Simple example:

mpvpaper DP-2 /path/to/video

To play the same video on all outputs:

mpvpaper ALL /path/to/video

You can also forward mpv options by passing "--mpv-options" or "-o" like so:

mpvpaper -o "no-audio --loop-playlist shuffle" HDMI-A-1 www.url/to/playlist

You can also control mpvpaper just like mpv in the terminal with keyboard bindings.

But if you would like to control mpvpaper while it's forked, you could use a mpv input-ipc-server like this:

mpvpaper -o "input-ipc-server=/tmp/mpv-socket" DP-1 /path/to/video

Then input commands with socat. For example, toggle pause:

echo 'cycle pause' | socat - /tmp/mpv-socket

For more mpv commands read: https://mpv.io/manual/master/#command-interface

You can also take a look at scripts page for ideas or refrences.

For more info on mpvpaper, please refer the the man page.

Acknowledgments

License

This project is licensed under the GPLv3 License - see the LICENSE file for details