Update readme

MMM-EyeCandy.js

@@ -9,9 +9,12 @@ Module.register("MMM-EyeCandy", {
     defaults: {
         style: '1', // 1-52
         maxWidth: "100%", // Adjusts size of images. Retains aspect ratio.
-        ownImagePath: '', // Overrides style. Local path or internet URL's.
+        // Overrides style. Local path or internet URL's. This will be a list of urls that can be set
+        //in config.js
+        ownImagePaths: [],
         updateInterval: 5 * 60 * 1000, // set in config.js
         animationSpeed: 3000,
+        currentImg: 0,
     },
 
     start: function() {
@@ -109,20 +112,25 @@ Module.register("MMM-EyeCandy", {
             '84': 'https://media.giphy.com/media/VgBk8EZQILIaPIJymY/giphy.gif',
 
         }
-
         //	console.log(this.eyesUrls[this.config.style]);
-        if (this.config.ownImagePath != '') {
-            this.url = this.config.ownImagePath;
+        if (this.config.ownImagePaths.length >= 1) {
+            this.url = this.config.ownImagePaths[this.config.currentImg%this.config.ownImagePaths.length]; //the modulo operator (%) allows you to loop through the images provided
         } else {
             if (this.config.style != '') {
                 this.url = this.eyesUrls[this.config.style];
             }
         }
-
         // ADDED: Schedule update timer courtesy of ninjabreadman
         var self = this;
-        setInterval(function() {
-            self.updateDom(self.config.animationSpeed || 0); // use config.animationSpeed or revert to zero @ninjabreadman
+        const intervalId = setInterval(function() {
+            //the dom will not update if there are not images to cycle through
+            if (self.config.ownImagePaths.length > 1) {
+                self.config.currentImg += 1; //increasing the currentImg value in order to cycle through array of images
+                self.url = self.config.ownImagePaths[self.config.currentImg%self.config.ownImagePaths.length];
+                self.updateDom(self.config.animationSpeed || 0); // use config.animationSpeed or revert to zero @ninjabreadman
+            } else {
+                clearInterval(intervalId); //clear the interval if there is no need to cycle through images
+            }
         }, this.config.updateInterval);
 
     },
@@ -136,17 +144,14 @@ Module.register("MMM-EyeCandy", {
         var wrapper = document.createElement("div");
         var image = document.createElement("img");
         var getTimeStamp = new Date();
-        if (this.config.ownImagePath != '') {
-            image.classList.add = "photo";
-            image.src = this.url + "?seed=" + getTimeStamp;
 
-            image.style.maxWidth = this.config.maxWidth;
-        } else if (this.config.style != '') {
+        if (this.config.ownImagePaths.length > 1 || this.config.style != '') {
             image.classList.add = "photo";
             image.src = this.url + "?seed=" + getTimeStamp;
 
             image.style.maxWidth = this.config.maxWidth;
         }
+
         wrapper.appendChild(image);
 
         return wrapper;

README.md

@@ -1,125 +1,142 @@
-## MMM-EyeCandy
-
-Animated images that are superficially attractive and entertaining but intellectually undemanding.
-
-Add some EyeCandy to your mirror. Some are funny. Some are cool. All are entertaining.
-
-You can even choose your own local images or internet images.
-
-## Examples
-
-![](pix/1.gif), ![](pix/2.gif),
-
-![](pix/4.gif),
-
-## Installation
-
-* `git clone https://github.com/mykle1/MMM-EyeCandy.git` into the `~/MagicMirror/modules` directory.
-* No API needed!
-
-## Config.js entry and options
-
-```
-{
-    module: "MMM-EyeCandy",
-    position: "top_center",
-    config: {
-        maxWidth: "75%",       // Sizes the images. Retains aspect ratio.
-        style: '1',            // Style number or use ownImagePath to override style
-        ownImagePath: '',      // ex: 'modules/MMM-EyeCandy/pix/YOUR_PICTURE_NAME.jpg', or internet url to image
-    }
-},
-```
-
-## Choose your config.js "style:" from this list.
-
-# Just the number!
-
-*  1 - Crazy human eye
-*  2 - Cartoon eyes
-*  3 - Cat-like eyes (red)
-*  4 - Cat-like eyes (green)
-*  5 - Wolf-like eyes (golden)
-*  6 - Cartoon eyes (yellow)
-*  7 - Wolf-like eyes (blue)
-*  8 - Cartoon eyes (blue)
-*  9 - Single cartoon eye (blue)
-* 10 - Rotating 3D eye
-* 11 - Blinking 3D marble sphere eye
-* 12 - Eye rolling
-* 13 - Human eye looking through hole
-* 14 - Your name in lights (go to http://www.picgifs.com/name-graphics. Choose your name. Use ownImagePath.
-
-## Faces and heads
-
-* 15 - Female face warp
-* 16 - Male face warp
-* 17 - Male face to mask
-* 18 - Ancient male face (Best in class)
-* 52 - Bad hair day (female)
-* 38 - 3D skull
-* 46 - 3D skull of light
-
-## Some of these are stunning
-
-* 19 - 3D object
-* 20 - 3D object (alive?)
-* 21 - Wreath of arms and hands
-* 22 - 3D object (tire?)
-* 23 - Circle of motion
-* 24 - Pulsating globual
-* 25 - Colored (paper object?)
-* 26 - Hairy thing
-* 27 - Metallic undulating thing
-* 28 - Inside out
-* 29 - Not a pretzel
-* 30 - Endless coral snake?
-* 31 - Tilt O' Whirl tree
-* 32 - Kaleidoscope?
-* 33 - 3D Cube
-* 34 - Endless butterfly?
-* 35 - Not quite a zebra
-* 36 - Hollow ball of colored string
-* 37 - Star eating plasma
-* 39 - A whatchamacallit?
-* 40 - A different whatchamacallit?
-* 41 - 7/8 of a cow donut
-* 42 - Yin and Yang like you've never seen before
-* 43 - Endless coral snake pretzel?
-* 44 - Clouds passing the moon
-* 45 - Hollow 3D sphere of dots
-* 47 - Liquid candy
-* 48 - Liquid candy 2
-* 49 - Johnny Dep? WTF? ( Use ownImagePath for the same effect )
-
-## Smiley
-
-* 50 - The cutest fucking 3D smiley face. (Are you mad I said "cutest" or "fucking?")
-* 51 - When smiley faces are in love it's pathetic.
-
-## I need some space
-
-* 53 - Slow moon rotation
-* 54 - Fast moon rotation
-* 55 - Moon in your garage (Pretty sick)
-* 56 - Earth rotates
-* 59 - Jupiter
-* 60 - Jupiter2
-* 61 - Mars with moons
-* 62 - Venus
-* 63 - Earth Phases
-* 64 - The sun
-
-## When your wife/GF wants something girly on your Mirror
-
-* 57 - Girly girlyFantasy
-* 58 - Girly girlyFantasy2
-
-## Too lazy to name but no less cool
-
-* 65-84
-
-
-## Remember!
-
-* You can always use local files that you have or url's to internet photos
+## MMM-EyeCandy
+
+Animated images that are superficially attractive and entertaining but intellectually undemanding.
+
+Add some EyeCandy to your mirror. Some are funny. Some are cool. All are entertaining.
+
+You can even choose your own local images or internet images.
+
+if you put multiple paths in the ownImagePath config key, then it will turn into a slide show.
+
+you can change the speed of transition and animation by putting the following keys in the config
+{
+...
+updateInterval: 5 * 60 * 1000, // set in config.js
+animationSpeed: 3000,
+...
+}
+## Examples
+
+![](pix/1.gif), ![](pix/2.gif),
+
+![](pix/4.gif),
+
+## Installation
+
+* `git clone https://github.com/mykle1/MMM-EyeCandy.git` into the `~/MagicMirror/modules` directory.
+* No API needed!
+
+## Config.js entry and options
+
+```
+{
+    module: "MMM-EyeCandy",
+    position: "top_center",
+    config: {
+        maxWidth: "75%",       // Sizes the images. Retains aspect ratio.
+        style: '1',            // Style number or use ownImagePath to override style
+        ownImagePath: [],      // ex: ['modules/MMM-EyeCandy/pix/YOUR_PICTURE_NAME.jpg', 'modules/MMM-EyeCandy/pix/YOUR_PICTURE_NAME2.jpg']. can also be a combination of internet and local images
+    }
+},
+```
+
+stated above, but to repeat the point, you can change the speed of transition and animation by putting the following keys in the config 
+config: {
+...
+updateInterval: 5 * 60 * 1000, // set in config.js
+animationSpeed: 3000,
+...
+}
+
+## Choose your config.js "style:" from this list.
+
+# Just the number!
+
+*  1 - Crazy human eye
+*  2 - Cartoon eyes
+*  3 - Cat-like eyes (red)
+*  4 - Cat-like eyes (green)
+*  5 - Wolf-like eyes (golden)
+*  6 - Cartoon eyes (yellow)
+*  7 - Wolf-like eyes (blue)
+*  8 - Cartoon eyes (blue)
+*  9 - Single cartoon eye (blue)
+* 10 - Rotating 3D eye
+* 11 - Blinking 3D marble sphere eye
+* 12 - Eye rolling
+* 13 - Human eye looking through hole
+* 14 - Your name in lights (go to http://www.picgifs.com/name-graphics. Choose your name. Use ownImagePath.
+
+## Faces and heads
+
+* 15 - Female face warp
+* 16 - Male face warp
+* 17 - Male face to mask
+* 18 - Ancient male face (Best in class)
+* 52 - Bad hair day (female)
+* 38 - 3D skull
+* 46 - 3D skull of light
+
+## Some of these are stunning
+
+* 19 - 3D object
+* 20 - 3D object (alive?)
+* 21 - Wreath of arms and hands
+* 22 - 3D object (tire?)
+* 23 - Circle of motion
+* 24 - Pulsating globual
+* 25 - Colored (paper object?)
+* 26 - Hairy thing
+* 27 - Metallic undulating thing
+* 28 - Inside out
+* 29 - Not a pretzel
+* 30 - Endless coral snake?
+* 31 - Tilt O' Whirl tree
+* 32 - Kaleidoscope?
+* 33 - 3D Cube
+* 34 - Endless butterfly?
+* 35 - Not quite a zebra
+* 36 - Hollow ball of colored string
+* 37 - Star eating plasma
+* 39 - A whatchamacallit?
+* 40 - A different whatchamacallit?
+* 41 - 7/8 of a cow donut
+* 42 - Yin and Yang like you've never seen before
+* 43 - Endless coral snake pretzel?
+* 44 - Clouds passing the moon
+* 45 - Hollow 3D sphere of dots
+* 47 - Liquid candy
+* 48 - Liquid candy 2
+* 49 - Johnny Dep? WTF? ( Use ownImagePath for the same effect )
+
+## Smiley
+
+* 50 - The cutest fucking 3D smiley face. (Are you mad I said "cutest" or "fucking?")
+* 51 - When smiley faces are in love it's pathetic.
+
+## I need some space
+
+* 53 - Slow moon rotation
+* 54 - Fast moon rotation
+* 55 - Moon in your garage (Pretty sick)
+* 56 - Earth rotates
+* 59 - Jupiter
+* 60 - Jupiter2
+* 61 - Mars with moons
+* 62 - Venus
+* 63 - Earth Phases
+* 64 - The sun
+
+## When your wife/GF wants something girly on your Mirror
+
+* 57 - Girly girlyFantasy
+* 58 - Girly girlyFantasy2
+
+## Too lazy to name but no less cool
+
+* 65-84
+
+
+## Remember!
+
+* You can always use local files that you have or url's to internet photos