slideshow

slideshow-api's client to set (scaled) images as background via 'feh' and retrieve color palettes.

requirements

• feh

configuration

configuration is entirely done via environment variables.

variable	default	description
SLIDESHOW_API		the address of the slideshow-api server
SLIDESHOW_INTERVAL	60	the interval of the slideshow in seconds
SLIDESHOW_RESOLUTION		the resolution to which images are scaled (i.e. 1920x1080)
SLIDESHOW_PALETTE		path to a file where the color palette will be stored
SLIDESHOW_PALETTE_ALGORITHM	"wsm"	the algorithm used to generate the color palette
SLIDESHOW_PALETTE_COLORS	16	the amount of colors generated
SLIDESHOW_SCRIPT		path to a script to execute after each loop
SLIDESHOW_SCRIPT_ASYNC	false	run the script asynchronously (in a goroutine)
SLIDESHOW_SCRIPT_STAGE		the stage at which the script is executed
SLIDESHOW_LOGLEVEL	"info"	the log level

note:

• if SLIDESHOW_RESOLUTION is unset images will be requested in their original resolution.
• if SLIDESHOW_PALETTE is unset no color palettes will be requested.
• if SLIDESHOW_SCRIPT_STAGE is unset the script (if specified) will be executed after the background image has been set and the color palette file has been generated.

stages:

• pre_image: executes the script before the background image will be set.
• post_image: executes the script after the background image has been set.
• pre_palette: executes the script before the color palette file will be generated.
• post_palette: executes the script after the color palette has been generated.

log levels:

• debug
• info
• warning
• error
• fatal

color palette

available algorithms:

• wsm
• wu

for more information regarding the color palette see color-thief.