Made a birthday module

[cgillinger]

@xIExodusIx I believe I’ve solved the issue where MMM-Birthday-Pages was taking over the entire screen when active. There’s now a new toggle, immersiveMode, which can be set to either “true” or “false”.

"false" allows the birthday celebration to overlay existing modules while keeping them visible.
"true" means only the birthday celebration is displayed, hiding everything else.

This also means you can have different behaviors on different Pages.

That said, I’ve only had time for a quick test, and it worked as expected on my Linux Mint installation. To be safe, I’ve uploaded it to a separate test repository. If it proves to be stable, I’ll merge it into the main one (I’m sure there are easier ways to do this, but I suck at Git). Repo URL:
https://github.com/cgillinger/mmm-Birthday-paged-test (and please note that you need to rename the folder to “mmm-Birthday-paged” after cloning)

So, give it a try and let me know how it goes!

[xIExodusIx]

@cgillinger
Hi cgillinger,
I installe your new module “MMM-Birthday-Pages-test” as described, and added the “immersiveMode” to the MM2 main config file.
It seems to work partly, it accepted the positon, on my MM2 “lower_third”, but it ignores the page and it shows some debug informations with green text on the left side by partly hiding the funny icon and parts of the gratulation text.
The fireworks is displayd on fullscreen but in my short test i can’t see the confetti.

A little idea for make it for user a bit easier: make it possible to set the firworks in the MM2 main config-file instead to copy it from to… somthing like “Fireworks: “spiral”” and let it load directly out of the of the “…/fireworks/” folder instead to copy it to the MMM-Birthday-Paged folder.

I will install the “old” MMM-Birthday-paged" and install it as I had it before. It has its own page on my MM2, and it worked very well.

[cgillinger]

@xIExodusIx Hi!

First, the green debug code was displayed because I forgot to set it to “false” by default. You can change this in config.js, but I’ll update the default setting so it only appears when the user wants it (ie when setting “true” in config.js).

Second, the module still has some quirks in its startup behavior—it requires a full cycle before everything runs smoothly. I’m working on it, but to be honest, it’s a low-priority fix since it’s a fringe case. Typically, the module will be running continuously, so birthday initialization should trigger when the mirror is already active. That’s probably why you’re not seeing the confetti right away.

Third, regarding the different versions of Fireworks—absolutely! The reason there are multiple versions is simply that I left them in from my experiments. I didn’t originally plan to include that functionality, but once the core features are fully ironed out, I’d be happy to refine and expand on it.

As for positioning, the module is currently designed to use the entire screen. I might look into allowing more customization in the future, but for now, it just places the message in the center and then launches confetti and fireworks.

When you say it “ignores the page,” are you referring to the page cycling?

I’ve also attached my test config.js. It has three pages, and after cycling through them to align the timings, the expected behavior should be:

Page 1 – Normal modules
Page 2 – Birthday celebration with dimming
Page 3 – Birthday celebration without dimming

Test config.js (which needs MMM-page-indicator). I’ve let this run for about an hour now, and everything (apart from weather module because its not part of the test) works as intended:

/* MagicMirror² Config for testing MMM-Birthday-Paged with immersiveMode */
let config = {
    address: "localhost",
    port: 8080,
    basePath: "/", 
    ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
    useHttps: false, 
    httpsPrivateKey: "", 
    httpsCertificate: "", 

    language: "en",
    locale: "en-US",
    logLevel: ["INFO", "LOG", "WARN", "ERROR", "DEBUG"],
    timeFormat: 24,
    units: "metric",

    modules: [
        {
            module: "alert",
        },
        {
            module: "clock",
            position: "top_left",
            classes: "page1 page3" // Show on page 1 and 3
        },
        {
            module: "calendar",
            header: "Holidays",
            position: "top_left",
            classes: "page1 page3", // Show on page 1 and 3
            config: {
                calendars: [
                    {
                        symbol: "calendar-check",
                        url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"
                    }
                ]
            }
        },
        {
            module: "weather",
            position: "top_right",
            classes: "page1 page3", // Show on page 1 and 3
            config: {
                weatherProvider: "yr",
                type: "current",
                location: "Stockholm",
                locationID: "2673730", // Stockholm's ID
                roundTemp: true
            }
        },
        {
            module: "compliments",
            position: "lower_third",
            classes: "page1 page3", // Show on page 1 and 3
        },
        // MMM-Birthday-Paged with immersiveMode = true (dims modules)
        {
            module: "MMM-Birthday-Paged",
            position: "middle_center",
            classes: "page2", // Show on page 2
            config: {
                birthdays: [
                    // Today's date (March 16, 2025) with name John
                    { name: "John", date: "03-16" } 
                ],
                fireworkDuration: "infinite",
                confettiDuration: "infinite",
                immersiveMode: true, // Dims other modules
                debug: true,
                startupDelay: 500 // Shorter startup delay for testing
            }
        },
        // MMM-Birthday-Paged with immersiveMode = false (original module behavior)
        {
            module: "MMM-Birthday-Paged",
            position: "middle_center",
            classes: "page3", // Show on page 3
            config: {
                birthdays: [
                    // Today's date (March 16, 2025) with name John
                    { name: "John", date: "03-16" } 
                ],
                fireworkDuration: "infinite",
                confettiDuration: "infinite",
                immersiveMode: false, // Does NOT dim other modules
                debug: true,
                startupDelay: 500 // Shorter startup delay for testing
            }
        },
        // Page indicator to see which page is showing
        {
            module: "MMM-page-indicator",
            position: "bottom_bar",
            config: {
                pages: 3
            }
        },
        // MMM-pages for page switching
        {
            module: "MMM-pages",
            config: {
                modules: [
                    ["page1"],   // Page 1 - Normal modules
                    ["page2"],   // Page 2 - Birthday celebration with dimming
                    ["page3"]    // Page 3 - Birthday celebration without dimming
                ],
                fixed: ["alert", "MMM-page-indicator"],
                rotationTime: 15000, // 15 seconds between page changes
                rotationDelay: 15000,
                animationTime: 1000
            }
        }
    ]
};

/*************** DO NOT EDIT THE LINE BELOW ***************/
if (typeof module !== "undefined") {module.exports = config;}

[plainbroke]

@cgillinger
Instead of infinite can a time be used in the 2 Duration fields?
If I set it to the same value as my pages rotate in, I was wondering if that might fix the problem of it over riding into my other pages.?
Just a thought, but do you think it would work?

[cgillinger]

@plainbroke Yes, that might do the trick! If MagicMirror manages to keep the two settings in sync.