MagicMirror README

The project's README from github.com/MagicMirrorOrg/MagicMirror. As one markdown file: README.md.

MagicMirror²: The open source modular smart mirror platform.

License GitHub Actions Build Status GitHub Stars

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!

Animated demonstration of MagicMirror²

Documentation

For the full documentation including installation instructions, please visit our dedicated documentation website: https://docs.magicmirror.builders.

Contributing Guidelines

Contributions of all kinds are welcome, not only in the form of code but also with regards to

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.

MagPi Top 50

MagicMirror (MagicMirrorOrg/MagicMirror)

Searching Database…

Что это такое?MagicMirror2 — это модульная платформа умного зеркала с открытым исходным кодом. Она превращает зеркало в коридоре или ванной в персонального помощника: на экране за полупрозрачным зеркальным стеклом показываются модули, например погода, календарь и новости.
Это готовое приложение или основа, на которой я сам что-то строю?Это модульное приложение на базе Electron, которое выводит изображение на экран. Оно запускается как настольное приложение, без отдельного веб-сервера и без установки браузера. Расширять его можно, устанавливая или написав собственные модули.
Как его запустить?Следуйте инструкциям по установке на специальном сайте документации, затем запустите через скрипты npm: 'install-mm' для установки зависимостей для продакшена и 'start' для запуска.
Что нужно иметь перед установкой?Нужны Node.js (версия >=22.21.1 =24) и npm. Для разработки и тестирования также устанавливается Playwright с Chromium.
Оно работает только на Raspberry Pi за зеркалом или его можно использовать и в других местах?Его часто собирают на базе Raspberry Pi для умных зеркал. Но так как оно работает на Node.js и Electron, оно кроссплатформенное и запускается на любом компьютере, который может их запустить, а не только на Pi.
Могу ли я сам добавить свои функции?Да, MagicMirror2 построен на модульной системе плагинов. Можно написать свои модули или установить созданные сообществом, чтобы добавить новые виджеты на экран зеркала.
Нужно ли мне настоящее полупрозрачное зеркало, чтобы это попробовать?Нет, само программное обеспечение просто работает как приложение Electron и выводит модули на экран. Полупрозрачное зеркальное стекло и рама — это отдельная аппаратная сборка, которую добавляют потом.
Почему Electron, а не веб-сервер и браузер?Проект перешёл на Electron как на оболочку приложения, чтобы пользователям не нужно было запускать отдельный веб-сервер или устанавливать браузер для просмотра интерфейса зеркала.
Size
26.9 MB
Stars
24.1K
Age
12y
Commits · 90 Days