kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-07-01 21:43:26 +00:00
Code Issues Projects Releases Wiki Activity

Removed my API additions

Paul-Vincent Roll 2016-02-07 22:13:33 +01:00
parent bcd309cdc3
commit 845e935f61
1 changed files with 1 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Module-System-Proposal.asciidoc

@ -38,20 +38,7 @@ Every module in the module folder should contain the module.js file defining a c
Any helper scrips (php) should be in the module folder, and should not affect any other module or the main system. There should be a way to start scripts (python, node etc.) as daemons. Maybe some kind of API to send data back to the modules should be implemented (socket.io & UNIX sockets).
## API functionality
### Multilayout
`function overwriteRegion(region, content) { ... }` - Function to temporarily overwrite regions used by other modules and replace their content (for multiuser applications or showing information after login)
`function restoreRegion(region) { ... }` - Function to restore regions to their original state. Also add an `all` input to restore all regions changed by the plugin.
Maybe it would be better to implement some kind of general multiuser/multilayout system, so that in config.js you can specify different module sets for different users/views. Modules could than be used to switch them by providing face, speech or whatever recognition.
`function changeLayout(layout) { ... }` - Function to change the current layout used by the UI. Modules should be aware of which user (or no user) is logged in or which layout is active so informations can also be changed.
For some views it might also be nice to have some more regions in the middle part for displaying information.
image::http://i.imgur.com/hzs7BNO.png[regions]
## API Design
***