slideshow/README.md

43 lines
1.6 KiB
Markdown
Raw Normal View History

2023-11-16 15:26:24 +01:00
# slideshow
2023-11-16 15:27:48 +01:00
a simple cli application to start a background image slideshow using 'feh'.
2023-11-16 15:26:24 +01:00
## requirements
- [feh](https://feh.finalrewind.org/)
2023-11-16 15:27:48 +01:00
- [ImageMagick](https://imagemagick.org/) (optional)
2023-11-16 15:26:24 +01:00
## 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_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 |
2023-11-16 15:26:24 +01:00
2023-11-16 15:28:55 +01:00
**note:**
2023-11-16 15:26:24 +01:00
if no resolution is set the images will be displayed as they are (without any scaling).
**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).