- Detect monitor resolutions and set the desktop wallpaper, for any window manager (please file an issue if your window manager is not supported yet).
- Supports GNOME timed wallpapers, and includes a utility that can run an event loop for changing them (also supports cross fading).
- Introduces a new file format for timed wallpapers: The Simple Timed Wallpaper format: Markdown | PDF.
- GNOME timed wallpapers can be converted to the Simple Timed Wallpaper format with the
xml2stwutility. - macOS dynamic wallpapers (in the HEIF format with the
.heicextension) can be installed withheic-installand used withlstimedandsettimed. This extracts the metadata withheic2stw(only timing information, not the azimuth and elevation for the sun, yet) and extracts the images withconvertthat comes with ImageMagick.
The Mojave timed wallpaper and other timed wallpapers can be set with the settimed command, and will cross fade from image to image as the day progresses:
Note that some window managers makes it hard to achieve smooth switches of desktop backgrounds, while others makes it easy.
getdpi, for retrieving the average DPI, for all monitors (use-bto see the DPI both horizontally and vertically).lscollection, for listing installed wallpaper collections (use-lfor also listing paths and collection names).timedinfo, for showing more information about installed timed wallpapers.lsmonlists the connected monitors and resolutions that are discovered by the current WM/DE (use-dfor also listing DPI).lstimedfor listing installed timed wallpapers (use-lfor also listing paths).lswallpaper, for listing all installed wallpapers (use-land-sto list more information).setcollection, for setting a suitable (in terms of resolution) wallpaper from a wallpaper collection.setrandom, for setting a random wallpaper.settimed, for setting timed wallpapers (will continue to run, to handle time events). (This utility has recently been refactored and needs more testing).setwallpapercan be used for setting a wallpaper (works both over X and the Wayland protocol).wayinfoshows detailed information about the connected monitors, via Wayland.xinfoshows detailed information about the current X setup.xml2stwfor converting GNOME timed wallpapers to the Simple Timed Wallpaper format.heic2stwfor extracting the timing information from macOS dynamic wallpapers (.heicfiles) to the Simple Timed Wallpaper format.vramfor finding the minimum amount of VRAM available for non-integrated GPUs (use-lto list the bus ID, a description and available VRAM for each GPU).
heic-installfor installing a macOS dynamic wallpaper to/usr/share/backgroundsusing both ImageMagickconvertandheic2stw.
$ lsmon
0: 1920x1200
1: 1920x1200
2: 1920x1200pacman -S wallutils
With sudo, or as root, install the required dependencies:
sudo dnf update
sudo dnf install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-$(rpm -E %fedora).noarch.rpm
sudo dnf install git golang ImageMagick libXcursor-devel libXmu-devel xorg-x11-xbitmaps libheif-devel wayland-devel
As a user, clone the repository and build the utilities:
git clone https://github.com/xyproto/wallutils
cd wallutils
make
Then with sudo, or as root, install the utilities:
sudo make PREFIX=/usr/local install
With sudo, or as root, install the required dependencies:
sudo apt install git golang imagemagick libx11-dev libxcursor-dev libxmu-dev libwayland-dev libxpm-dev xbitmaps libxmu-headers libheif-dev make
As a user, clone the repository and build the utilities:
git clone https://github.com/xyproto/wallutils
cd wallutils
make
Then with sudo, or as root, install the utilities:
sudo make PREFIX=/usr/local install
Using Go 1.17 or later, install ie. the getdpi utility:
go install github.com/xyproto/wallutils/cmd/getdpi@latest
The executables related to X can be removed after building if you only wish to keep the Wayland-related functionality. And the same for Wayland.
settimed mojave-timed
setwallpaper /path/to/background/image.png
setrandom /usr/share/pixmaps
package main
import (
"fmt"
"os"
"github.com/xyproto/wallutils"
)
func main() {
// Retrieve a slice of Monitor structs, or exit with an error
monitors, err := wallutils.Monitors()
if err != nil {
fmt.Fprintf(os.Stderr, "%s\n", err)
os.Exit(1)
}
// For every monitor, output the ID, width and height
for _, monitor := range monitors {
fmt.Printf("%d: %dx%d\n", monitor.ID, monitor.Width, monitor.Height)
}
}fmt.Println("Setting background image to: " + imageFilename)
if err := wallutils.SetWallpaper(imageFilename); err != nil {
return err
}- Go 1.11 or later. 1.17 or later is recommended.
- A working C compiler (tested with GCC 8.2.1).
- Header files for Wayland and X.
libheifforheic2stwandheic-install.
libwayland-client.so, for Wayland support.libX11.so, for X support.libheif.sofor HEIF/.heicimage support.
It is also possible to build with make static, to only build the utilities that does not depend on any of the above .so files, as statically compiled ELF executables.
swaybgandpkillfor Wayland-based window managers likeLabwc.
The vram utility depends on lspci (from pciutils) and also nvidia-smi for NVIDIA GPUs.
The XML format from GNOME for specifying wallpaper collections is not yet supported (and I'm not sure if it's needed). Creating a directory with images where the filename of the images specify the resolution (like wallpaper_5639x3561.jpg) is enough for lscollection to recognize it as a collection (if the directory is placed in /usr/share/backgrounds or /usr/share/wallpapers).
Send the USR1 signal to the settimed process:
pkill settimed -USR1
This should refresh the wallpaper.
- When using wallutils together with
i3, it works best with also havingfehandimlib2installed.
- Setting a wallpaper per monitor is not supported, yet. Currently, a wallpaper is set for all monitors.
- Author: Alexander F. Rødseth <[email protected]>
- License: BSD-3
- Version: 5.12.7
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent