Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 1.74 KB

README.md

File metadata and controls

67 lines (53 loc) · 1.74 KB

Module: MMM-Valentine

Initial idea by tamug1.

Most of the code shamelessly borrowed from MMM-Snow module by @MichMich which was inspired by NHubbard's Snow Plugin

Icons designed by Freepik from Flaticon.

Installation

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

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/morozgrafix/MMM-Valentine.git

Configure the module in your config.js file.

Note: After starting the Mirror, it will take a few seconds before the valentine themed icons begin to fall ...

Using the module

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

modules: [
	{
		module: 'MMM-Valentine',
		position: 'fullscreen_above',
		config: {
			// See 'Configuration options' for more information.
		}
	}
]

Configuration options

The following property can be configured:

Option Description
valentinesCount The number of valentine themed icons to fall. More icons are havier for the cpu, so don't go wild.
Default value: 50
valentinesSize Scale ratio for each icon, to help adjustments for different screen resolutions.
Default value: 1.00