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 and feh. You can check a demo on reddit. See details in the documentation.

screenshot

Features

  • Vim keys
  • Support for GIF animations (with swww)
  • Support for multiple monitors (with swww)
  • Works on both Wayland (with swww or swaybg or wallutils) and 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 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-git

The waypaper-git package is available in AUR, thanks to metak. Please upvote to support the project.

On NixOS

The waypaper package is available thanks to Basil Keeler.

Dependencies

  • swww or swaybg or feh or wallutils
  • gobject python library (it might be called python-gobject or python3-gi or python3-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.

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


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.1.tar.gz (32.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

waypaper-2.1-py3-none-any.whl (33.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waypaper-2.1.tar.gz
  • Upload date:
  • Size: 32.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for waypaper-2.1.tar.gz
Algorithm Hash digest
SHA256 1b81241e30232da90cfbb366ee96645bcb978cfab7346fbc71762b8e644ed26f
MD5 e9095b6d830cb632bcb0f22bc21c96c7
BLAKE2b-256 257463f42de1c8cb6dcfb0f4a3019041df442189576684475fa7dae94f43bdba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: waypaper-2.1-py3-none-any.whl
  • Upload date:
  • Size: 33.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for waypaper-2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5300206cc6b19cd70fc5ae1203ff33d4127805db5060f9b9c3f431590c72ddcc
MD5 66ff4e6bd779d8c658f580706834fdc2
BLAKE2b-256 c9d750225245612f3145207d7aea1b64debbbc9a184220b66c18833b551deed3

See more details on using hashes here.

Supported by

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