MMM-Fireworks

• Multiple Scheduled Events: The module now accepts an array of scheduled events (each with its own start time and text message). At each event time, the fireworks start with the corresponding overlay text.

• Notification Triggers:

• Two separate notifications have been added:
  • NotificationStart (e.g. "FireFireFire") starts the fireworks immediately using either the notification’s payload text or a default (textNotification).
  • NotificationStop (e.g. "StopFire") stops the fireworks immediately if they are running.
• When a notification is received, it overrides the scheduled events temporarily without affecting future scheduled shows.

Example:

The MMM-Fireworks module brings a visually stunning fireworks display to your MagicMirror, designed to celebrate special occasions. The fireworks animation runs best in the fullscreen_above region, creating an immersive experience. The start time and duration of the display are configurable via the config.js file.

In your terminal, go to your MagicMirror² Module folder and clone MMM-Fireworks:

cd ~/MagicMirror/modules
git clone https://github.com/ChrisF1976/MMM-Fireworks.git

cd ~/MagicMirror/modules/MMM-Fireworks
git pull

To use this module, add it to the modules array in the config/config.js file:

	{
	  module: "MMM-Fireworks",
	  position: "fullscreen_above",
	  config: {
	        // Scheduling: an array of event objects with a start time and text message.
    		startDateTime: [
    		   { time: "2025-02-09T07:00:00", text: "Happy Birthday, Homer!" },
    		   { time: "2025-10-03T07:00:00", text: "Happy Birthday, Lisa!" },
    		   { time: "2025-12-31T23:59:55", text: "Happy New Year to my Simpsons!" }
    		   ],
    		duration: 6 * 60 * 60 * 1000,        // Duration in milliseconds (6 hours)
    		// p5 Fireworks settings:
    		fireworkSpawnChance: 0.2, 	        // Chance each frame to spawn a new firework - adjust carefuly beased on your hardware
    		explosionParticleCount: 30, 	    // Number of particles per explosion - adjust carefuly beased on your hardware
    		// Display settings:
    		fullscreen: true,      		        // If false, use defined width/height.
    		width: "400px",
    		height: "500px",
    		// Velocity settings for rocket particles:
    		magnitude_high: -19,		        //adjust to your screen size. Try a little.
    		magnitude_low: -8,		            //adjust to your screen size. Try a little.
    		// Trailing effect transparency:
    		transparency: 10,		            //min: 0 max: 255
    		canvasOpacity: 0.5,		            //opacity for the canvas
    		// Module management:
    		disableAllModules: false,
    		keepModules: ["clock"],
    		// Notification triggers:
    		NotificationStart: "FireFireFire",	//Module listens to this message
    		NotificationStop: "StopFire",		//Module listens to this message
    		textNotification: "Fire!", 		    //used if no text is received from notification
    		// Default text for scheduled events (usually not needed):
            text: "Happy New Year!"
	  }
	},

Starts the fireworks effect at a configured date and time for a specified duration.

Allows you to adjust parameters such as rocket velocity, explosion particle count, and trailing transparency.

Can run in full-screen mode or within defined dimensions.

Optionally hides other modules during the fireworks display (with exceptions you can configure).

Displays customizable overlay text (e.g., "Happy New Year!") with CSS-controlled styling and positioning.

Perfect for occasions like:

• New Year's Eve: Kick off the new year with an exciting visual treat.
• Birthdays or Anniversaries: Highlight special moments with colorful displays.
• National Holidays: Celebrate with virtual fireworks that light up your MagicMirror.

• Open AI
• my wife :-)