Skip to content

rockhazard/rwal

Repository files navigation

README

rwal

What is rwal?

rwal is a cross-platform desktop wallpaper manager. It automatically detects the current user's environment then randomly selects and applies an image from a directory or list to the user's desktop background. It supports GNOME3 (Gnome Shell, Unity, Cinnamon, Mate), KDE4 & 5, XFCE 4.10, LXDE, Openbox, OSX, and Windows 7+. It has been confirmed to work on many window managers as well, such as i3 and Qtile, using feh.

Why?

rwal is designed to turn your background into a kind of flipbook. It's particularly for those who have huge image collections but haven't seen some images in a long time due to the size of those collections and the time required to browse them. rwal may delight users with images they'd forgotten they ever had.

Features

  • Auto-detects most environments, such as Windows, OSX, and all common Linux desktop environments
  • Randomly or alphabetically select images from one of five user-preset directories, in addition to the default directory.
  • Specify an image directory on the commandline.
  • Specify a list of images from a newline-separated text file.
  • In addition to random selection, the user can apply a manually selected image.
  • Walks through the list of images in the last used directory, turning your background into a flipbook/photo album. This feature works with all the above features.
  • A slideshow, using either random or alphabetical settings.
  • Filter images by the aspect ratio of your screen (or choose from a number of manual alternatives), so you never have to see a background that doesn't fit again.
  • Edit the current background with a quick command.
  • Lightweight and highly scriptable, rwal is designed to be used with shortcuts and other programs, in addition to being tiny and highly portable.

How do I get set up?

  • GNOME and Xfce: These environments do not require any setup, but see rwal.conf for customizations.

  • KDE: Setup via "Default Desktop Settings". Using the slideshow option, set "Change images every" to lowest, and select ~/.config/rwal/kde/mon1, then apply settings.

  • Openbox: Install feh and apply feh's background settings in autostart.sh.

  • Windows 7+: In order to use the image filtering feature, Windows users must install Python 3 and get the Pillow wheel from: http://www.lfd.uci.edu/~gohlke/pythonlibs/ Launch cmd.exe and run pip install [name of Pillow file] from Pillow's directory. It is recommended to use rwal in conjunction with a keybinding program, such as AutoHotkey.

Dependencies:

when running from source

  • Python 3.2+
  • Python 3 Pillow and Tkinter

source and binary

  • feh (required for Openbox and other windows managers)
  • xclip (for automatically copying wallpaper path to clipboard)
  • A supported environment (GNOME3, Cinnamon2x, KDE, Xfce, Openbox, Windows 7+, or MacOSX)

Debian/Ubuntu/Linux Mint notes: sudo apt-get install python3-pil python3-tk xclip feh

Configuration:

On first run, rwal does not set a wallpaper. Instead, a configuration folder is created as [user]/.config/rwal/[env]. rwal.conf, background.conf, and images.txt files are created there. Use rwal.conf to set your image directories and default config editor. Otherwise, rwal will use [user]/Pictures by default on its next execution.

Examples:

  • To use the default image directory rwal.py

  • To specify a directory at the commandline rwal.py -d /path/to/directory

  • To specify the first of five predefined directoies rwal.py -1

  • To use a list of newline-separated image paths rwal.py -l /path/to/images/list.txt

  • To advance to the next image in a directory or list rwal.py -n

  • For more help rwal.py -h

Changelog

v3.5 "Akira"

  • '--reshuffle': random selection from current image's directory and below
  • '--present': random selection from the present working directory, ignoring subdirectories
  • optionally use newline-separated lists of image paths instead of directories
  • Config file
  • Windows 7 function
  • Addition of LXDE and KDE5 functions
  • Improved Slideshow function
  • Improved error handling and bugfixes
  • Image filtering with Pillow

v3.0 "Scratchy"

  • First Python3 version.
  • Improved speed and image collection
  • Enhanced features, like slideshow
  • Next/Previous works in all environs now

v2.5 "Itchy"

  • Final shell script version

Contact

rockhazardz@gmail.com

About

A feature-rich cross platform commandline program that turns your desktop background into a flipbook or slide show.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages