README.md

MMM-Facts: A MagicMirror Module

Displays some facts. Makes your mirror look like an RPG loading screen. No APIs needed.

Installing the module

Clone this repository in your ~/MagicMirror/modules/ folder:

git clone https://github.com/alanshen111/MMM-Facts

Using the module

Add the module to the ~/MagicMirror/config/config.js file:

modules: [
		{
			module: 'MMM-Facts',
			position: 'bottom_bar',
		}
]

You may also add configurations:

modules: [
		{
			module: 'MMM-Facts',
			position: 'bottom_bar',
			config: {
					updateInterval: 5,
					fadeSpeed: 4,
					category: 'random',
			}
		}
]

Configuration options

Options	Description
updateInterval	Time it takes for the fact to change in seconds
fadeSpeed	Time it takes for the fact to fade out in seconds.
category	Default is random, but you can choose specific categories such as art, food, health, history, language, nature, nerd, space or tips. Feel free to add your own as well!

How to add your own facts

You can edit the MMM-Facts.js file, if you are comfortable merging them with any remote changes. Alternatively, you may fork this repository to have an exclusive copy you can edit without conflicts.