Add module subfolder support.

modules/default/compliments/README.md

@@ -0,0 +1,87 @@
+# Module: Compliments
+The `compliments` module is one of the default modules of the MagicMirror.
+This module displays a random compliment. 
+
+## Using the module
+
+To use this module, add it to the modules array in the `config/config.js` file:
+````javascript
+modules: [
+	{
+		module: 'compliments',
+		position: 'lower_third',	// This can be any of the regions.
+									// Best results in one of the middle regions like: lower_third
+		config: {
+			// The config property is optional.
+			// If no config is set, an example calendar is shown.
+			// See 'Configuration options' for more information. 
+		}
+	}
+]
+````
+
+## Configuration options
+
+The following properties can be configured:
+
+
+<table width="100%">
+	<!-- why, markdown... -->
+	<thead>
+		<tr>
+			<th>Option</th>
+			<th width="100%">Description</th>
+		</tr>
+	<thead>
+	<tbody>
+
+		<tr>
+			<td><code>updateInterval</code></td>
+			<td>How often does the compliment have to change? (Milliseconds)<br>
+				<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
+				<br><b>Default value:</b> <code>30000</code> (30 seconds)
+			</td>
+		</tr>
+		<tr>
+			<td><code>fadeSpeed</code></td>
+			<td>Speed of the update animation. (Milliseconds)<br>
+				<br><b>Possible values:</b><code>0</code> - <code>5000</code>
+				<br><b>Default value:</b> <code>4000</code> (4 seconds)
+			</td>
+		</tr>
+		<tr>
+			<td><code>compliments</code></td>
+			<td>The list of compliments.<br>
+				<br><b>Possible values:</b> An object with three arrays: <code>morning</code>, <code>afternoon</code> and<code>evening</code>. See <i>compliment configuration</i> below.
+				<br><b>Default value:</b> See <i>compliment configuration</i> below.
+			</td>
+		</tr>
+	</tbody>
+</table>
+
+### Compliment configuration
+
+The `compliments` property contains an object with three arrays: <code>morning</code>, <code>afternoon</code> and<code>evening</code>. Based on the time of the day, the compliments will be picked out of one of these arrays. The arrays contain one or multiple compliments.
+
+#### Default value:
+````javascript
+config: {
+	compliments: {
+		morning: [
+			'Good morning, handsome!',
+			'Enjoy your day!',
+			'How was your sleep?'
+		],
+		afternoon: [
+			'Hello, beauty!',
+			'You look sexy!',
+			'Looking good today!'
+		],
+		evening: [
+			'Wow, you look hot!',
+			'You look nice!',
+			'Hi, sexy!'
+		]
+	}
+}
+````

modules/default/compliments/compliments.js

@@ -0,0 +1,123 @@
+/* global Log, Module, moment */
+
+/* Magic Mirror
+ * Module: Compliments
+ *
+ * By Michael Teeuw http://michaelteeuw.nl
+ * MIT Licensed.
+ */
+
+Module.register('compliments',{
+
+	// Module config defaults.
+	defaults: {
+		compliments: {
+			morning: [
+	            'Good morning, handsome!',
+	            'Enjoy your day!',
+	            'How was your sleep?'
+	        ],
+	        afternoon: [
+	            'Hello, beauty!',
+	            'You look sexy!',
+	            'Looking good today!'
+	        ],
+	        evening: [
+	            'Wow, you look hot!',
+	            'You look nice!',
+	            'Hi, sexy!'
+	        ]
+		},
+		updateInterval: 30000,
+		fadeSpeed: 4000
+	},
+
+	// Define required scripts.
+	getScripts: function() {
+		return ['moment.js'];
+	},
+
+	// Define start sequence.
+	start: function() {
+		Log.info('Starting module: ' + this.name);
+		
+		this.lastComplimentIndex = -1;
+
+		// Schedule update timer.
+		var self = this;
+		setInterval(function() {
+			self.updateDom(self.config.fadeSpeed);
+		}, this.config.updateInterval);
+	},
+
+
+	/* randomIndex(compliments)
+	 * Generate a random index for a list of compliments.
+	 *
+	 * argument compliments Array<String> - Array with compliments.
+	 *
+	 * return Number - Random index.
+	 */
+	randomIndex: function(compliments) {
+		if (compliments.length === 1) {
+			return 0;
+		}
+
+		var generate = function() {
+			return Math.floor(Math.random() * compliments.length);
+		};
+
+		var complimentIndex = generate();
+
+		while (complimentIndex === this.lastComplimentIndex) {
+			complimentIndex = generate();
+		}
+
+		this.lastComplimentIndex = complimentIndex;
+
+		return complimentIndex;
+	},
+
+	/* complimentArray()
+	 * Retrieve an array of compliments for the time of the day.
+	 *
+	 * return compliments Array<String> - Array with compliments for the time of the day.
+	 */
+	complimentArray: function() {
+		var hour = moment().hour();
+
+		if (hour >= 3 && hour < 12) {
+			return this.config.compliments.morning;
+		} else if (hour >= 12 && hour < 17) {
+			return this.config.compliments.afternoon;
+		} else {
+			return this.config.compliments.evening;
+		}
+	},
+
+	/* complimentArray()
+	 * Retrieve a random compliment.
+	 *
+	 * return compliment string - A compliment.
+	 */
+	randomCompliment: function() {
+		var compliments = this.complimentArray();
+		var index = this.randomIndex(compliments);
+
+		return compliments[index];
+	},	
+
+	// Override dom generator.
+	getDom: function() {
+		var complimentText = this.randomCompliment();
+
+		var compliment = document.createTextNode(complimentText);       
+		var wrapper = document.createElement("div");
+		wrapper.className = 'thin xlarge bright';
+		wrapper.appendChild(compliment);
+
+		return wrapper; 
+	}
+	
+});
+