mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 11:50:00 +00:00
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
# MagicMirror V2
|
|
This version of the Magic Mirror software focusses on a modular plugin system. Besides that, the Magic Mirror software now also uses [Electron](http://electron.atom.io/), so no more webserver or browser installs necessary.
|
|
|
|
#WARNING: THIS VERSION IS IN A VERY EARLY STAGE. IT IS NOT COMPLETED YET. PLEASE USE THE MASTER BRANCH.
|
|
|
|
##Usage
|
|
1. Install [Node.js](https://nodejs.org/en/)
|
|
2. Execute `npm install && npm start`.
|
|
|
|
##Configuration
|
|
1. Duplicate `config/config.js.sample` to `config/config.js`.
|
|
2. Modify your required settings.
|
|
|
|
##Todo
|
|
Things that still have to be implemented or changed.
|
|
|
|
####Loader
|
|
- Loading of module uses `eval()`. We might want to look into a better solution. [loader.js#L112](https://github.com/MichMich/MagicMirror/blob/v2-beta/js/loader.js#L112).
|
|
|
|
####NodeHelper
|
|
- The node_helper superclass creates a seperate socket connection for each module. It's preferred to use the overall socket connection of the server.
|
|
|
|
##Modules
|
|
|
|
### Default modules
|
|
##### Clock
|
|
##### Current Weather
|
|
##### Weather Forecast
|
|
##### News Feed
|
|
##### Compliments
|
|
##### Hello World
|
|
|
|
### 3rd Party Modules
|
|
|
|
#####[MMM-FRITZ-Box-Callmonitor by PaViRo](https://github.com/paviro/MMM-FRITZ-Box-Callmonitor)
|
|
**Features:** FRITZ!Box Callmonitor (displays alert when someone is calling)
|
|
|
|
|
|
|
|
|
|
|