velvettear/slideshow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
client for 'slideshow-api'
27 commits 1 branch 0 tags 83 KiB
Go 100%
Find a file
velvettear 9e5b1aaf2d fixed some copy/paste errors
2023-11-23 17:08:06 +01:00
.vscode fixed some copy/paste errors 2023-11-23 17:08:06 +01:00
images initial commit 2023-11-16 15:26:24 +01:00
internal removed 'watcher' in favor of 'scanner' 2023-11-23 16:57:43 +01:00
scanner fixed some copy/paste errors 2023-11-23 17:08:06 +01:00
.gitignore fixed .gitignore 2023-11-16 15:29:55 +01:00
go.mod extended service, tidied up 'go.mod' 2023-11-23 16:59:13 +01:00
go.sum extended service, tidied up 'go.mod' 2023-11-23 16:59:13 +01:00
LICENSE.md initial commit 2023-11-16 15:26:24 +01:00
main.go removed 'watcher' in favor of 'scanner' 2023-11-23 16:57:43 +01:00
README.md removed 'watcher' in favor of 'scanner' 2023-11-23 16:57:43 +01:00
slideshow.service extended service, tidied up 'go.mod' 2023-11-23 16:59:13 +01:00

README.md

slideshow

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

requirements

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_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 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.