> For the complete documentation index, see [llms.txt](https://anufrievroman.gitbook.io/waypaper/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://anufrievroman.gitbook.io/waypaper/readme.md).

# Waypaper

Change wallpapers with a style

GUI wallpaper setter for Wayland and Xorg window managers on Linux. It works as a frontend for popular wallpaper backends like `swaybg`, `swww`, `wallutils`, `hyprpaper` and `feh`. Developed by [Roman Anufriev](https://anufrievroman.gitbook.io/anufriev-roman/) since 2023.

<figure><img src="https://279303465-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9CSZ4SBWxG67yHDJCKZB%2Fuploads%2F8V8WMXo33ilZlHMufPjd%2Fscreen.jpg?alt=media&amp;token=5d0201c4-c85b-4aeb-b021-df887cfa62dd" alt=""><figcaption></figcaption></figure>

### Features

* Vim-style keyboard navigation
* Support for GIF animations (with `swww`, `awww`, `mpvpaper`, or `gslapper`)
* Support for video wallpapers (with `mpvpaper`, `gslapper`, or `linux-wallpaperengine`)
* Support for multiple monitors
* Works on Wayland (with `swww`, `awww`, `swaybg`, `hyprpaper`, `mpvpaper`, `gslapper`, or `wallutils`)
* Works on Xorg (with `feh`, `xwallpaper`, or `wallutils`)
* Works on macOS (native support)
* Restores wallpaper at launch of your WM
* Caching for fast loading
* Zen mode for a minimal, distraction-free interface
* Post-command hook to run a script after each wallpaper change
* Customizable CSS stylesheet for theming

### Contents

* [Installation](/waypaper/installation.md)
* [Usage](/waypaper/usage.md)
* [Keybindings](/waypaper/keybindings.md)
* [Configuration](/waypaper/configuration.md)
* [Troubleshooting](/waypaper/troubleshooting.md)
* [Support and contribution](/waypaper/support-and-contribution.md)

### Demo

{% embed url="<https://www.youtube.com/watch?v=O9OL7iH_KVY>" %}

### Repositories

* Code: <https://github.com/anufrievroman/waypaper>
* Documentation: <https://github.com/anufrievroman/waypaper-docs>

If you enjoy using Waypaper, please consider [supporting](/waypaper/support-and-contribution.md) the project.