README.md

MMM-CoupleDays

MagicMirror² Module that displays the number of days, weeks, months, and years since a specified date, serving as a romantic reminder for couples.

Dependencies

• instance of MagicMirror²

Installation

1. Clone this repository into your modules folder and install node dependencies:

   cd ~/MagicMirror/modules
   git clone https://github.com/wiesty/MMM-CoupleDays
   cd MMM-CoupleDays
   npm install

2. Modify the config template below

3. Add configuration to your config.js

Example Config

{
  module: "MMM-CoupleDays",
  position: "bottom_right",
  config: {
    name1: "Partner 1",
    name2: "Partner 2", // If name2 is "", it only shows the first name (for birthday trackers for exmaple)
    date: "2023-01-01", // year-month-day
    transitionDuration: 5000, // in ms
    language: "en", // (filename without the .json from the translations folder)
    textColor: "white" // any valid CSS color value For example, "red," or "#FFA500" (hex color)
  }
},

The module allows you to customize the names of the partners, the starting date, and the transition duration for smooth animations. It automatically calculates the elapsed time and updates the display every second.

The module supports different styles of displaying the time, which transition in a loop with a configurable duration. The styles include showing only the number of days, the number of weeks, the number of months, or a combination of years, months, weeks, and days.

Contributions

Help with translating the module is always appreciated!

Credits:

• de - wiesty
• en - wiesty
• it - IGOLz
• fr - torjc01
• pt - torjc01
• zh-cn - wedding0371
• nl - Koesie77
• hr - luaxv
• ? - maybe you :) ?

Developer commands

• npm run lint:check - Run linting and formatter checks.
• npm run lint:fix - Fix linting and formatter issues.