GitHub - darickc/MMM-BackgroundSlideshow

imagePaths Array value containing strings. Each string should be a path to a directory where image files can be found. Can be relative or absolute

Example: ['modules/MMM-BackgroundSlideshow/exampleImages/']
Example: ['/images/']
This value is REQUIRED

excludePaths Array value containing strings. When scanning subdirectories for images, directories with these names will be ignored.

Example: ['@eaDir']
Default value: ['@eaDir']
This value is OPTIONAL

slideshowSpeed Integer value, the length of time to show one image before switching to the next, in milliseconds.

Example: 6000 for 6 seconds
Default value: 10000 or 10 seconds
This value is OPTIONAL

resizeImages Boolean value, if images should be resized or not. For better performance, this should be true and the height and width set to the resolution of the monitor being used

Example: true
Default value: false
This value is OPTIONAL

maxWidth Integer value, the width the image should be resized to.

Example: 3840
Default value: 1920
This value is OPTIONAL

maxHeight Integer value, the height the image should be resized to.

Example: 2160
Default value: 1080
This value is OPTIONAL

randomizeImageOrder Boolean value, if true will randomize the order of the images, otherwise use sortImagesBy and sortImagesDescending sorting by filename.

Example: true
Default value: false
This value is OPTIONAL

randomizeImagesLoopFolders Boolean value, if true will randomize the order of all images and then create a filelist so that the images will ordered to show one image from each subfolder before next image index is shown. Subfolders with fewer images will loop so that all subfolders will get equal amount of time in the spotlight

Example: true
Default value: false
This value is OPTIONAL

showAllImagesBeforeRestart Boolean value, if true will keep track of all the allready shown files and not show them untill all images has been shown

Example: true
Default value: false
This value is OPTIONAL

sortImagesBy String value, determines how images are sorted. Possible values are: name (by file name), created (by file created date), modified (by file modified date). Only used if randomizeImageOrder is set to false.

Example: created
Default value: name
This value is OPTIONAL

sortImagesDescending Boolean value, if true will sort images in descending order, otherwise in ascending order. Only used if randomizeImageOrder is set to false.

Example: true
Default value: false
This value is OPTIONAL

recursiveSubDirectories Boolean value, if true it will scan all sub-directories in the imagePaths.

Example: true
Default value: false
This value is OPTIONAL

validImageFileExtensions String value, a list of image file extensions, separated by commas, that should be included. Files found without one of the extensions will be ignored.

Example: 'png,jpg'
Default value: 'bmp,jpg,jpeg,gif,png'
This value is OPTIONAL

showImageInfo Boolean value, if true a div containing the currently displayed image information will be shown.

Example: true
Default value: false
This value is OPTIONAL

imageInfoLocation String value, determines which corner of the screen the image info div should be displayed in. Possible values are: bottomRight, bottomLeft, topLeft, topRight

Example: topLeft
Default value: bottomRight
This value is OPTIONAL

imageInfo String value, a list of image properties to display in the image info div, separated by commas. Possible values are : date (EXIF date from image), name (image name), description, desc_name (description with fallback to name), position.
For the image name, the relative path from that defined in imagePaths is displayed if the recursiveSubDirectories option is set to true.

Example: date,name
Default value: name
This value is OPTIONAL

imageInfoNoFileExt Boolean value, if true the file extension will be removed before the image name is displayed.

Example: true
Default value: false
This value is OPTIONAL

transitionSpeed Transition speed from one image to the other, transitionImages must be true. Must be a valid css transition duration.

Example: '2s'
Default value: '1s'
This value is OPTIONAL

showProgressBar Boolean value, if true a progress bar indicating how long till the next image is displayed is shown.

Example: true
Default value: false
This value is OPTIONAL

backgroundSize The sizing of the background image. Values can be:
cover: Resize the background image to cover the entire container, even if it has to stretch the image or cut a little bit off one of the edges.
contain: Resize the background image to make sure the image is fully visible

Example: 'contain'
Default value: 'cover'
This value is OPTIONAL

backgroundPosition Determines where the background image is placed if it doesn't fill the whole screen (i.e. backgroundSize is 'contain'). Module already defaults to 'center', so the most useful options would be: 'top' 'bottom' 'left' or 'right'. However, any valid value for CSS background-position could be used.

Example: 'top'
Default value: 'center'
This value is OPTIONAL

transitionImages Transition from one image to the other (may be a bit choppy on slower devices, or if the images are too big).

Example: true
Default value: false
This value is OPTIONAL

gradient The vertical gradient to make the text more visible. Enter gradient stops as an array.

Example: [ "rgba(0, 0, 0, 0.75) 0%", "rgba(0, 0, 0, 0) 40%" ]
Default value: [ "rgba(0, 0, 0, 0.75) 0%", "rgba(0, 0, 0, 0) 40%", "rgba(0, 0, 0, 0) 80%", "rgba(0, 0, 0, 0.75) 100%" ]
This value is OPTIONAL

horizontalGradient The horizontal gradient to make the text more visible. Enter gradient stops as an array.

radialGradient A radial gradient to make the text more visible. Enter gradient stops as an array.

Example: [ "rgba(0, 0, 0, 0.75) 0%", "rgba(0, 0, 0, 0) 40%" ]
Default value: [ "rgba(0,0,0,0) 0%", "rgba(0,0,0,0) 75%", "rgba(0,0,0,0.25) 100%"" ]
This value is OPTIONAL

gradientDirection The direction of the gradient

Example: 'horizontal'
Default value: 'vertical'
Possible values: 'vertical', 'horizontal', 'both', 'radial'
This value is OPTIONAL

backgroundAnimationEnabled Boolean value, if set to true the background will scroll if the picture is larger than the screen size (e.g. for panaramic pictures). The picture will either scroll vertically or horizontally depending on which dimension extends beyond the screen size. Note: For this to work, backgroundSize must be set to cover.

Example: true
Default value: false
This value is OPTIONAL

transitions Array value containing strings defining what transitions to perform. Note: transitionImages must be set to true.

Example: ['opacity', 'slideFromLeft']
Default value: ['opacity', 'slideFromRight', 'slideFromLeft', 'slideFromTop', 'slideFromBottom', 'slideFromTopLeft', 'slideFromTopRight', 'slideFromBottomLeft', 'slideFromBottomRight', 'flipX', 'flipY']
Possible values: 'opacity', 'slideFromRight', 'slideFromLeft', 'slideFromTop', 'slideFromBottom', 'slideFromTopLeft', 'slideFromTopRight', 'slideFromBottomLeft', 'slideFromBottomRight', 'flipX', 'flipY'
This value is OPTIONAL

transitionTimingFunction CSS timing function used with transitions. Note: transitionImages must be set to true.

Example: 'ease-in
Default value: 'cubic-bezier(.17,.67,.35,.96)'
Possible values: 'ease', 'linear', 'ease-in', 'ease-out', 'ease-in-out', 'cubic-bezier(n,n,n,n)'
This value is OPTIONAL

animations Array value containing strings defining what animations to perform. Note: backgroundAnimationEnabled must be set to true.

Example: 'ease-in
Default value: ['slide', 'zoomOut', 'zoomIn']
Possible values: 'slide', 'zoomOut', 'zoomIn'
This value is OPTIONAL

changeImageOnResume Should the image be changed in the moment the module resumes after it got hidden?

Example: true
Default value: false
This value is OPTIONAL

googleMapsApiKey To geocode position (ie convert to readable address)

Example: ALzaTrucMachin5g
Default value: ''
This value is OPTIONAL

addressCacheFile To cache geocoding results

Example: config/addressCache.json
Default value: ''
This value is OPTIONAL, but definitely you should have one if you geocode

photoSignalUrl External backend server 's URL where `BACKGROUNDSLIDESHOW_SIGNAL_PHOTO` sends photo's Google URL (found in takeout json metadata) to signal issues (for instance, uninteresting pictures).
Sends a POST with fields photoUrl, filename, creationTime to a server.
This could be useful to rezise, rotate, modify or delete some photos from Google Photos, when you use MMM-BackgroundSlideshow to show photos from a Google Takeout.

Example: http://myserver.com/handle_photo.php"
Default value: ''
This value is OPTIONAL

excludeDescriptionsRegexps Descriptions (found in takeout json metadata) matching are not kept (array of regexps)

Example: [/uploaded with Flickr Uploader/u]
Default value: ''
This value is OPTIONAL

cleanImageName: false Remove all words (separated by spaces or /) that contain at least one number

2012/IMG_4242 nice landscape.HEIC will end as nice landscape
Example: true
Default value: false
This value is OPTIONAL