diff --git a/CHANGELOG.md b/CHANGELOG.md index c5b5d31e..d3acbcc4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Added option `disabled` for modules. - Added option `address` to set bind address. - Added option `onlyTemp` for currentweather module to show show only current temperature and weather icon. +- Added option `remoteFile` to compliments module to load compliment array from filesystem. ### Updated - Modified translations for Frysk. diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index 911de4b0..1dab242a 100644 --- a/modules/default/compliments/README.md +++ b/modules/default/compliments/README.md @@ -56,6 +56,15 @@ The following properties can be configured:
Default value: See compliment configuration below. + + remoteFile + External file from which to load the compliments
+
Possible values:Path to a JSON file containing compliments, configured + as per the value of the compliments configuration (see below). An object with three arrays: + morning, afternoon and evening. - compliments.json +
Default value: null (Do not load from file) + + @@ -123,3 +132,32 @@ config: { } } ```` + +### External Compliment File +You may specify an external file that contains the three compliment arrays. This is particularly useful if you have a +large number of compliments and do not wish to crowd your `config.js` file with a large array of compliments. +Adding the `remoteFile` variable will override an array you specify in the configuration file. + +This file must be straight JSON. Note that the array names need quotes +around them ("morning", "afternoon", "evening", "snow", "rain", etc.). +#### Example compliments.json file: +````json +{ + "morning" : [ + "Good morning, sunshine!", + "Who needs coffee when you have your smile?", + "Go get 'em, Tiger!" + ], + "afternoon" : [ + "Hitting your stride!", + "You are making a difference!", + "You're more fun than bubble wrap!" + ], + "evening" : [ + "You made someone smile today, I know it.", + "You are making a difference.", + "The day was better for your efforts." + ] +} +```` +