GUI wallpaper setter for Wayland
Project description
Waypaper
GUI wallpaper setter for Wayland and Xorg window managers. It works as a frontend for popular wallpaper backends like swaybg
, swww
, wallutils
, hyprpaper
and feh
. See details in the documentation.
Features
- Vim keys
- Support for GIF animations (with
swww
) - Support for multiple monitors (with
swww
) - Works on Wayland (with
swww
orswaybg
orhyprpaper
orwallutils
) - Works on Xorg (with
feh
orwallutils
) - Restores wallpaper at launch of your WM
- Caching for fast loading
Installation
You need to install at least one of the backends and Waypaper, which works as a frontend.
1. Install a backend
Install a preferred backend from your package manager: swww or swaybg or swaybg on Wayland or feh on Xorg or wallutils on both.
2. Install Waypaper
Waypaper is available as a package in different repositories listed below:
On all distributions
pipx install waypaper
If pipx
is not found, you first need to install pipx
from your package manager, it's sometimes called python-pipx
.
On Arch-based distributions
yay -S waypaper
or yay -S waypaper-git
The waypaper and waypaper-git packages are available in AUR, thanks to metak. Please upvote to support the project.
On NixOS
The waypaper
package is available thanks to Basil Keeler.
On OpenSUSE
Users of OpenSUSE reported issue with installation via pipx install waypaper
. This might be resolved by installing the python311-pycairo-devel
package.
On Fedora
Waypaper is available in an external repository owned by Solopasha. You can add this repository as sudo dnf copr enable solopasha/hyprland
and install as sudo dnf install wayapaper
.
Dependencies
swww
orswaybg
orfeh
orwallutils
orhyprpaper
- gobject python library (it might be called
python-gobject
orpython3-gi
orpython3-gobject
in your package manager.) python-importlib_metadata
python-platformdirs
Usage
waypaper
command will run GUI application.
Options
To restore your wallpaper at launch, add waypaper --restore
to your startup config.
See more details on user arguments in the documentation.
Configuration
See configuration details in the documentation.
Keybindings
See list of keybindings in the documentation.
Troubleshooting
See typical problems explained in the documentation
Contribution and support
Feel free to propose PR and suggest the improvements. I'll highly appreciate help with packaging for various distributions. If you wish to contribute with translation into your language, please see the translations.py
file.
I am not a professional developer and work on open-source projects in my free time. If you'd like to support the development, consider donations via buymeacoffee or cryptocurrencies:
- BTC
bc1qpkzmutdqfxkce34skt09vll97s5smpa0r2tyzj
- ETH
0x6f1Ce9cA181458Fc153a5f7cBF88044736C3b00C
- BNB
0x40f22c372758E35C905458cAF8BB17f51ac133d1
- LTC
ltc1qtu33qyv2xlzxda5mmrmk943zpksq8q75tuh85p
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.