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 作为显示外壳的模块化应用,所以能作为桌面应用运行,不需要单独的 Web 服务器或浏览器;你可以通过安装或编写模块来扩展它。
我该怎么让它运行起来?按照专门的文档网站上的安装说明操作,然后通过 npm 脚本运行,例如用 'install-mm' 安装生产依赖,用 'start' 启动。
安装前我需要准备什么?你需要 Node.js(版本 >=22.21.1 =24)和 npm;如果用于开发或测试,还会安装带 Chromium 的 Playwright。
它只能在镜子后面的树莓派上运行吗?我能在别的地方用吗?它常见于基于树莓派的镜子方案,但由于它运行在 Node.js 和 Electron 上,只要能运行这两者的任何电脑都可以用,并不局限于树莓派。
我能自己添加自定义功能吗?可以。MagicMirror2 围绕模块化插件系统构建,你可以自己编写模块,或安装社区制作的模块,为镜子显示屏添加新的小组件。
想试用这个,一定要有实体的双向镜吗?不需要。软件本身只是以 Electron 应用的形式在屏幕上显示模块;双向镜玻璃和边框是另外的硬件组装,之后再添加即可。
为什么用 Electron,而不用 Web 服务器加浏览器?项目改用 Electron 作为应用外壳,这样用户就不需要单独运行 Web 服务器,也不用安装浏览器来查看镜子界面。
Size
26.9 MB
Stars
24.1K
Age
12y
Commits · 90 Days