Skip to main content

Cross-platform wallpaper manager that focuses on multi-monitor support. Features include ppi corrections, keyboard shortcuts, slideshow.

Project description

Superpaper

Superpaper is an advanced multi monitor wallpaper manager for Linux and Windows operating systems, with partial and untested support for Mac OS X.

Supported Linux desktop environments / window managers are:

  • BSPWM (needs feh)
  • Budgie
  • Cinnamon
  • Gnome
  • i3 (needs feh)
  • KDE*
  • LXDE & LXQt
  • Mate
  • Pantheon
  • XFCE*

and additionally there is support for

  • feh
  • supplying a custom command to set the wallpaper

if support for your system of choice is not built-in.

*KDE and XFCE work most reliably with monitors in a single horizontal row: some configurations with 3 or more displays in a complex/non-row setup can have issues with spanning.

Features

  • Set a single image across all displays
  • Set different image on every display
  • Pixel per inch correction*: span an image flawlessly across displays of different shapes and sizes!
  • Bezel correction*
  • Manual pixel offsets for fine-tuning
  • Slideshow with configurable file order from local sources
  • Command-line interface
  • Tray applet for slideshow control
  • GUI for settings configuration
  • Hotkey support for easy slideshow control (Only Linux and Windows)
  • Align test tool to help fine tune your settings (Accessible only from GUI)

Span single image and set multiple image modes should work on most multi monitor arrangements.

*For PPI and bezel corrections only a single horizontal row of monitors is supported at this time. Monitors can be in portrait. For PPI correction Superpaper assumes that your displays' physical center points are on a horizontal line, if they are not you can adjust the wallpaper using the manual offset.

In the above banner photo you can see the PPI and bezel corrections in action. The left one is a 27" 4K display, and the right one is a 25" 1440p display.

Support

If you find Superpaper useful please consider supporting its development: Support via PayPal or Support via Github Sponsors. Github matches your donations done through the sponsorship program!

Installation

Linux

Superpaper is available from PyPI, here.

Requirements

  • Python 3.5+
  • Pillow
  • screeninfo
  • wxpython (tray applet, GUI & slideshow, optional)
  • system_hotkey (hotkeys, optional)
  • xcffib (dep for system_hotkey)
  • xpybutil (dep for system_hotkey)

If you install Superpaper from PyPI, pip will handle everything else other than wxPython. It will be easiest to install wxPython from your distribution specific package repository:

Arch / Manjaro

sudo pacman -S python-wxpython

Debian / Ubuntu and derivatives

sudo apt install python3-wxgtk4.0

Fedora

sudo dnf install python3-wxpython4

Python wheels (if wxPython4 is not in your standard repositories)

For a few CentOS, Debian, Fedora and Ubuntu flavors there are pre-built wheels so on those you can look at the instructions to install wxpython through pip, without having to build it as you do when installing directly from PyPI.

Installing other dependencies manually:

Install via pip3:

pip3 install -U Pillow screeninfo system_hotkey xcffib xpybutil

Running CLI only

If you are going to run only in CLI mode you will need to install the first two modules in the list:

pip3 install -U Pillow screeninfo 

Installing Superpaper from PyPI

Once wxPython4 is installed, you can just run:

pip3 install -U superpaper

This will install an icon and .desktop file for menu entries.

Windows

For Windows an installer and a portable package are available under releases. These work on a download-and-run basis without additional requirements. In the portable package, look for the executable "superpaper.exe" in the subfolder "superpaper".

If you want to run the cloned repo on Windows, on top of the requirements listed in the Linux section, you will need the "pywin32" module (instead of the xcffib and xpybutil modules). Installation through pip:

pip3 install -U Pillow screeninfo wxpython system_hotkey pywin32

Max OS X

Basic support for OS X has been kept in the script but it has not been tested. If you want to try to run it, best bet would be to install the dependencies through pip:

pip install -U wxpython Pillow screeninfo

and then clone the repository.

Usage

You can either run Superpaper to use all of its features, or alternatively you may call it from the command-line to set your multi monitor wallpaper, with or without pixel density / bezel corrections or manual offsets.

Note: You might have to set your OS to span the wallpaper so it is displayed correctly regardless of the settings you give Superpaper:

  • On Windows: Personalization -> Background -> Choose a fit -> Span.

Full functionality / GUI mode

To provide your desired wallpaper settings, you access the 'Profile Configuration' Tray Menu item, or also during first run. General application settings are under 'Settings' in the Tray.

Profile configuration

Example profile configurations are provided and accessible in the Profile Configuration. (or in the Superpaper/profiles folder.)

Following settings are supported and they are expected in this form:

name=example
spanmode=single
slideshow=true
delay=600
sortmode=shuffle
offsets=0,0;0,0
bezels=9.5;7
diagonal_inches=27;25
hotkey=control+super+shift+x
display1paths=C:\Path\To\Image\Folder1;C:\Path\To\Image\Folder2;C:\Path\To\Image\Folder3

Accepted values and their explanations are:

  • spanmode:
    • single — Span a single image across all of your monitors. Use with or without PPI correction.
    • multi — Multi image mode: set different image on every display.
  • slideshow:
    • true
    • false
  • delay:
    • integer, slideshow delay in seconds
  • sortmode:
    • shuffle
    • alphabetical
  • offsets
    • horizontal,vertical pixel offsets with offsets of different monitors separated by ";"
  • bezels
    • List of adjacent monitor bezel pairs' thicknesses in millimeters, i.e. "bezel+gap+bezel", floats are accepted, values separated by ";".
    • Measure adjacent bezels and add them together with a possible gap to get a combined thickness. One value for 2 monitors, two values for 3 and so on.
  • diagonal_inches
    • List of monitor diagonals in inches. Used for computing display pixel densities (PPI).
  • hotkey
    • Up to three modifiers are supported for a hotkey: "control", "shift", "super" (the win-key) and "alt".
    • Separate keys with a "+" as shown above.
  • display1paths
    • List of local image source paths, separate paths with a ";".
    • display1paths is used by the left-most display.
  • display2paths
    • Same as display1paths, but for the 2nd monitor from the left.
    • For any additional displays paths are given via display3paths, display4paths, etc.

General settings

General settings are saved in Superpaper/general_settings and formatted in the following way:

logging=false
use hotkeys=true
next wallpaper hotkey=control+super+w
pause wallpaper hotkey=control+super+shift+p
set_command=gsettings set ...

Up to three modifiers are supported for a hotkey: "control", "shift", "super" (the win-key) and "alt".

The option 'set_command' accepts a user defined one liner to set the wallpaper if your system is not supported out of the box. As a special case, one can tell Superpaper to use feh with a tested and built-in command by setting:

set_command=feh

In the custom command, replace '/path/to/img.jpg' by '{image}', i.e. for example with the Gnome command:

gsettings set org.gnome.desktop.background picture-uri file://{image}

Lastly, if the included white tray icon doesn't go nicely with your rice, included are a couple of alternative colorations and you may even replace the default icon with anything you wish. Just overwrite the "default.png" icon file.

CLI usage

Superpaper supports the following arguments, display specific values are given starting from the first display on the left.

  • "--help"
  • "--setimages", list of images to set on your monitors, if given only one it will be spanned across.
  • "--inches", optional, expects display diagonals in inches to compute PPIs
  • "--bezels", optional, expects display bezels in millimeters
  • "--offsets", optional, if image alignment with ppi&bezels isn't quite right you can add additional offset in pixels
  • "--command", optional, user can pass a custom command to set the wallpaper.

An example using all corrections to set a single spanned image:

superpaper.py --setimages /path/to/img.png --inches 27 25 --bezels 9.5 7.0 --offsets 0 0 40 -100

Offsets are given as a pair-wise list of "horizontal_offset vertical_offset" starting from the first monitor on the left, i.e. in the above example the display on the left is given no additional offset (0 0) and the display on the right is given a horizontal offset to the right by 40px and a vertical offset of 100px up (40 -100).

In the custom command, replace '/path/to/img.jpg' by '{image}', i.e. for example with the Gnome command:

gsettings set org.gnome.desktop.background picture-uri file://{image}

The resulting image is saved into Superpaper/temp/ and then set as the wallpaper.

Troubleshooting

If you run into issues and Superpaper closes unexpectedly, you can either:

  • Enable logging in the 'general_settings' by setting 'logging=true'
  • Run Superpaper from the command-line with the switch '--debug' to get debugging prints.
python superpaper.pyw --debug

On KDE or XFCE if you're having issues on a larger multi monitor setup it might be worthwhile to try the 'feh' mode.

Stumbling stones to keep in mind if you have issues:

  • Check your image paths that there are no typos.
  • Check that there are no typos in your profile configs and that the profile name in the config matches the filename.

Known issues

General shortcomings

  • PPI & Bezel corr. only work on a single horizontal row of displays at this time, i.e. monitors side by side.
  • The module used for display data gathering seems to have issues with some setups, for example with Windows 10 DPI scaling.

Linux

  • (Found in virtual machine testing) In KDE and XFCE environments image spanning can have issues if monitors are not in a horizontal row. Found with 3 virtual displays in an "L" shape.

Windows

  • A rare issue where setting the wallpaper fails and leads to a black wallpaper. Might be related to source image properties.
  • Windows10 DPI scaling options can interfere with resolution detection and cause issues with background handling.

Mac OS X

  • It is not known whether this works at all. If you try it, tell me how it goes!
  • The library implementing global hotkeys does not support Mac OS X at this time unfortunately.

License

MIT

Project details


Download files

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

Files for superpaper, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size superpaper-1.2.0-py3-none-any.whl (239.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size superpaper-1.2.0.tar.gz (241.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page