Skip to main content

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, mpvpaper and feh. See details in the documentation.

screenshot

Features

  • Vim keys
  • Support for GIF animations (with swww or mpvpaper)
  • Support for videos (with mpvpaper)
  • Support for multiple monitors (with swww or swaybg or hyprpaper or mpvpaper)
  • Works on Wayland (with swww or swaybg or hyprpaper or wallutils or mpvpaper)
  • Works on Xorg (with feh or wallutils)
  • 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 hyprpaper on Wayland or feh on Xorg or mpvpaper 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

The waypaper package and developer package waypaper-git 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 waypaper.

Dependencies

  • swww or swaybg or feh or wallutils or hyprpaper or mpvpaper
  • gobject python library (it might be called python-gobject or python3-gi or python3-gobject in your package manager.)
  • python-importlib_metadata
  • python-imageio
  • python-imageio-ffmpeg
  • python-screeninfo
  • 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

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. Here a few guiding principles for creating pull requests:

  • Please do not apply automatic code formatting tools on the entire code base.
  • Please do separate pull requests for each feature, don't combine unrelated changes into one PR.
  • For big changes, please open an issue first to discuss, otherwise PR might be declined.

Support

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waypaper-2.4.tar.gz (42.1 kB view details)

Uploaded Source

Built Distribution

waypaper-2.4-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

Details for the file waypaper-2.4.tar.gz.

File metadata

  • Download URL: waypaper-2.4.tar.gz
  • Upload date:
  • Size: 42.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.5

File hashes

Hashes for waypaper-2.4.tar.gz
Algorithm Hash digest
SHA256 95477b06a21bab2dc947e47c096388637bdbecbaa3526ffa89b5c78103a72636
MD5 23243afee812c96d83420b5b545dc79c
BLAKE2b-256 ea2df7efce220cf89c35fed8819a74a4f9957adfe9951ec2d6258c2626054d26

See more details on using hashes here.

File details

Details for the file waypaper-2.4-py3-none-any.whl.

File metadata

  • Download URL: waypaper-2.4-py3-none-any.whl
  • Upload date:
  • Size: 42.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.5

File hashes

Hashes for waypaper-2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 11202a0dd0b44c5d63c6ca24878eb397461437aeb68f8ff7e645d4366d157892
MD5 a32c5a777b87d790ff187762dd03b349
BLAKE2b-256 d1a03661d9791323b06c8eecd2c1cd921e34d1a896d6304cf9de8518aff11b1c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page