Technical Documentation: MagicMirrorOrg/MagicMirror
ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference
Overview (`README.md`)
MagicMirror² is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant. MagicMirror² is built by the creator of the original MagicMirror with the incredible help of a growing community of contributors.
MagicMirror² focuses on a modular plugin system and uses Electron as an application wrapper. So no more web server or browser installs necessary!
Documentation
For the full documentation including installation instructions, please visit our dedicated documentation website: https://docs.magicmirror.builders.
Links
- Website: https://magicmirror.builders
- Documentation: https://docs.magicmirror.builders
- Forum: https://forum.magicmirror.builders
- Technical discussions: https://forum.magicmirror.builders/category/11/core-system
- Discord: https://discord.gg/J5BAtvx
- Blog: https://michaelteeuw.nl/tagged/magicmirror
- Donations: https://magicmirror.builders/#donate
Contributing Guidelines
Contributions of all kinds are welcome, not only in the form of code but also with regards to
- bug reports
- documentation
- translations
For the full contribution guidelines, check out: https://docs.magicmirror.builders/about/contributing.html
Enjoying MagicMirror? Consider a donation!
MagicMirror² is Open Source and free. That doesn't mean we don't need any money.
Please consider a donation to help us cover the ongoing costs like webservers and email services.
If we receive enough donations we might even be able to free up some working hours and spend some extra time improving the MagicMirror² core.
To donate, please follow this link.
Overview (`defaultmodules/alert/README.md`)
Module: Alert
The alert module is one of the default modules of the MagicMirror². This module displays notifications from other modules.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/calendar/README.md`)
Module: Calendar
The calendar module is one of the default modules of the MagicMirror².
This module displays events from a public .ical calendar. It can combine multiple calendars.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/clock/README.md`)
Module: Clock
The clock module is one of the default modules of the MagicMirror².
This module displays the current date and time. The information will be updated realtime.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/compliments/README.md`)
Module: Compliments
The compliments module is one of the default modules of the MagicMirror².
This module displays a random compliment.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/helloworld/README.md`)
Module: Hello World
The helloworld module is one of the default modules of the MagicMirror². It is a simple way to display a static text on the mirror.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/newsfeed/README.md`)
Module: News Feed
The newsfeed module is one of the default modules of the MagicMirror².
This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (updateInterval), but can also be controlled by sending news feed specific notifications to the module.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/updatenotification/README.md`)
Module: Update Notification
The updatenotification module is one of the default modules of the MagicMirror².
This will display a message whenever a new version of the MagicMirror² application is available.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/weather/README.md`)
Weather Module
This module will be configurable to be used as a current weather view, or to show the forecast. This way the module can be used twice to fulfill both purposes.
For configuration options, please check the MagicMirror² documentation.
Overview (`defaultmodules/weather/providers/README.md`)
Weather Module Weather Provider Development Documentation
For how to develop your own weather provider, please check the MagicMirror² documentation.
--- METRICS ---
- Files Extracted: 10
- Estimated Token Budget: ~1684 tokens
- Canonical Reference: https://codewiki.google/github.com/MagicMirrorOrg/MagicMirror