slideshow/README.md

# slideshow

a simple cli application to start a background image slideshow using 'feh'.

## requirements

- [feh](https://feh.finalrewind.org/)
- [ImageMagick](https://imagemagick.org/) (optional)

## configuration

configuration is entirely done via environment variables.

| variable                    | default           | description                                                |
| --------------------------- | ----------------- | -----------------------------------------------------------|
| SLIDESHOW_INTERVAL          | 60                | the interval of the slideshow in seconds                   |
| SLIDESHOW_DIRECTORY         | "$HOME"           | path to a directory containing images                      |
| SLIDESHOW_SCANINTERVAL      | 60                | the interval for directory scans in seconds                |
| SLIDESHOW_TMPFILE           |                   | path to a temporary file                                   |
| 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_LOGLEVEL          | "info"            | the log level                                              |

**note:**  
- if `SLIDESHOW_RESOLUTION` is unset the images will be displayed as they are (without any scaling).  
- if `SLIDESHOW_TMPFILE` is set a temporary file will be used instead of keeping the image internally buffered. this could be useful on systems with limited ram.  

**available log levels:**

- `debug`
- `info`
- `warning`
- `error`
- `fatal`

## color palette

**available algorithms:**  

- `wsm`
- `wu`

for more information regarding the color palette see [color-thief](https://github.com/kennykarnama/color-thief).