https://github.com/Ultimatum22/MMM-RandomBackground

https://github.com/Ultimatum22/MMM-RandomBackground

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/Ultimatum22/MMM-RandomBackground
• Owner: Ultimatum22
• License: apache-2.0
• Created: 2016-12-07T19:19:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-17T08:39:38.000Z (about 3 years ago)
• Last Synced: 2024-06-29T10:32:26.244Z (5 months ago)
• Language: JavaScript
• Size: 19.5 KB
• Stars: 9
• Watchers: 8
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-RandomBackground**

README

        
# MagicMirror Module: MMM-RandomBackground

A MagicMirror Module to show random backgrounds from a local folder on the Mirror.

## Installation

In your terminal, go to your MagicMirror's Module folder:

````

cd ~/MagicMirror/modules

git clone https://github.com/Ultimatum22/MMM-RandomBackground.git

npm install

````

Configure the module in the `config.js` file.

## Using the module

To use this module, add it to the modules array in the `config/config.js` file:

````javascript

modules: [

	{

		module : 'MMM-RandomBackground',

		position : 'fullscreen_below', // Any region but this one makes the most sense

		config : {

			animationSpeed : 2000,

			updateInterval : 5000

		}

	}

]

````

Create a folder named `photos` in the module directory and place the images to be displayed in this folder. Make sure that the file permissions are set correctly so that the MagicMirror process is able to read the files.

## Configuration options

The following properties can be configured:

	

		

			Option

			Description

		

	

	

		

			animationSpeed

			How fast the new image fades into the old one (in milliseconds). A higher value means a slower animation. Default is 1000 ms.

		

		

			updateInterval

			How often a new photo is displayed. Default is 10 minutes.

		

		

			showAdditionalInfo

			Show image meta info. Default is false.

		

		

			randomOrder

			Display images in random order. Default is true.

		

		

			opacity

			Opacity of the background. Ranged 0.0 to 1.0. Default is 1.0.

		

		

			photoDirectories

			[Functionality not yet implemented]