https://github.com/boazarad/MMM-CountDown

Magic Mirror Module to count down to a specific date
https://github.com/boazarad/MMM-CountDown

Last synced: 3 months ago
JSON representation

Magic Mirror Module to count down to a specific date

• Host: GitHub
• URL: https://github.com/boazarad/MMM-CountDown
• Owner: boazarad
• License: mit
• Created: 2018-03-15T12:49:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-07-02T23:13:07.000Z (over 4 years ago)
• Last Synced: 2024-06-29T09:34:53.683Z (5 months ago)
• Language: JavaScript
• Size: 23.4 KB
• Stars: 35
• Watchers: 5
• Forks: 24
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-mmm - **MMM-CountDown**

README

        
# MMM-CountDown

![Screenshot](https://github.com/boazarad/MMM-CountDown/raw/master/screenshots/screenshot.png)

This is a module for the [MagicMirror²](https://github.com/MichMich/MagicMirror/) which can count down the days to a date/event.

I've never written anything with Node.js before, so hopefully this isn't a total mess, if it is - feel free to lend a hand :)

## Using the module

To use this module, add the following configuration block to the modules array in the `config/config.js` file:

```js

var config = {

    modules: [

        {

            module: 'MMM-CountDown',

            config: {

                // See configuration options

            }

        }

    ]

}

```

## Configuration options

| Option           | Description                                                                                                           |

| ---------------- | --------------------------------------------------------------------------------------------------------------------- |

| `position`       | *Required* Where do you want to place the counter (use standard magicmirror positions)                                |

| `event`          | *Required* Name of event to count down to (displayed above counter)                                                   |

| `date`           | *Required* Date to count down to (YYYY-MM-DD HH:MM:SS)                                                                |

| `showHours`      | Decide whether or not to display the hours. Default is true                                                           |

| `showMinutes`    | Decide whether or not to display the minutes. Default is true                                                         |

| `showSeconds`    | Decide whether or not to display the seconds. Default is true                                                         |

| `customInterval` | Change the update interval which will help reduce load if you are only showing specific time metrics. Default is 1000 |

| `daysLabel`      | Choose how you wish to display your Days label. Default is d                                                          |

| `hoursLabel`     | Choose how you wish to display your Hours label. Default is h                                                         |

| `minutesLabel`   | Choose how you wish to display your Minutes label. Default is m                                                       |

| `secondsLabel`   | Choose how you wish to display your Seconds label. Default is m                                                       |

If either of the above are missing, the module will count down to the New Millenium (3000-01-01)