Skip to content

location of default modules changed #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KristjanESPERANTO merged 1 commit into from
Jan 27, 2026
Merged

location of default modules changed #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion module-development/core-module-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ MagicMirror will use this template to render your component. You may provide
data to the template with `getTemplateData`.

An example of a default module that uses this method is
[newsfeed](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/modules/default/newsfeed/newsfeed.js).
[newsfeed](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/defaultmodules/newsfeed/newsfeed.js).

Read more about Rendering Components
[in the Rendering Component documentation](/module-development/rendering.md).
Expand Down
4 changes: 2 additions & 2 deletions module-development/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ maintained by the MagicMirrorOrg.

## Module structure

All modules are loaded in the `modules` folder. The default modules are grouped
together in the `modules/default` folder. Your module should be placed in a
We have 2 folders. The default modules are grouped together in the `defaultmodules`
folder. All other modules should be placed in a
subfolder of `modules`. Note that any file or folder you create in the `modules`
folder will be ignored by git, allowing you to upgrade the MagicMirror² without
the loss of your files.
Expand Down
16 changes: 8 additions & 8 deletions module-development/notifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ These notifications are sent by the default modules:

| Notification | Payload | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SHOW_ALERT` | [message details](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert#notification-params) | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert) to show an alert or notification. |
| `HIDE_ALERT` | _none_ | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/alert) to hide the current alert or notification. |
| `CALENDAR_EVENTS` | [calendar events](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/calendar) | Sent by [calendar module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/calendar) to inform modules of the calendar events. |
| `ARTICLE_NEXT` | _none_ | Shows the next news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
| `ARTICLE_PREVIOUS` | _none_ | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
| `ARTICLE_MORE_DETAILS` | _none_ | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
| `ARTICLE_LESS_DETAILS` | _none_ | Hides the summary or full news article and only displays the news title of the currently viewed news item in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
| `ARTICLE_TOGGLE_FULL` | _none_ | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/newsfeed). |
| `SHOW_ALERT` | [message details](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert#notification-params) | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert) to show an alert or notification. |
| `HIDE_ALERT` | _none_ | Sent to [alert module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/alert) to hide the current alert or notification. |
| `CALENDAR_EVENTS` | [calendar events](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/calendar) | Sent by [calendar module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/calendar) to inform modules of the calendar events. |
| `ARTICLE_NEXT` | _none_ | Shows the next news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
| `ARTICLE_PREVIOUS` | _none_ | Shows the previous news title in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
| `ARTICLE_MORE_DETAILS` | _none_ | Shows more details in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
| `ARTICLE_LESS_DETAILS` | _none_ | Hides the summary or full news article and only displays the news title of the currently viewed news item in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |
| `ARTICLE_TOGGLE_FULL` | _none_ | Toggles article in fullscreen in [newsfeed module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/newsfeed). |

# 3rd Party Module notifications

Expand Down
2 changes: 1 addition & 1 deletion module-development/rendering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ this.nunjucksEnvironment().addFilter("space", function (str) {
```

For filter examples see the
[`weather` module](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/modules/default/weather/weather.js#L221).
[`weather` module](https://github.com/MagicMirrorOrg/MagicMirror/blob/master/defaultmodules/weather/weather.js#L221).
2 changes: 1 addition & 1 deletion modules/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ see [configuration](/configuration/introduction.md) for more information.

| **Option** | **Description** |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `default/calendar` and `custommodules/mymodule`. |
| `module` | The name of the module. This can also contain the subfolder. Valid examples include `clock`, `calendar` and `custommodules/mymodule`. |
| `position` | The location of the module in which the module will be loaded. The built in values are `top_bar`, `top_left`, `top_center`, `top_right`, `upper_third`, `middle_center`, `lower_third`, `bottom_left`, `bottom_center`, `bottom_right`, `bottom_bar`, `fullscreen_above`, and `fullscreen_below`. This field is optional but most modules require this field to set. (if not set, the module will not be shown, but will run the same) Check the documentation of the module for more information. Multiple modules with the same position will be ordered based on the order in the configuration file, top down. |
| | Note: <br><br>if your implementation of MagicMirror wishes to use custom position values, they need to be used in **index.html** , and in the format <br><br>class="region newpos-a newpos-b"<br> <br>MagicMirror will join the last two terms with an underscore to make a position value like <br><br>newpos-a_newpos-b<br><br>example: class="region top3 left" <br>the position will be "top3_left"<br><br>newpos_b is optional<br>class="region top3" would be valid and produce a position of "top3"<br><br>the new position values will be checked during MagicMirror startup and also in the configuration checker <br> node --run config:check <br><br> AND you have to have the appropriate css settings in custom.css for these new region values (top3 and left as used in the example above) |
| `classes` | One or more additional CSS classes which will be set on the module, as a string of space-separated values. This field is optional. |
Expand Down
2 changes: 1 addition & 1 deletion modules/customcss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ it to your `custom.css`-file like in the example above.

Each module has a class set for the div it resides in named after the module
(including all the 3rd-party modules). As an example the
[Clock-module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/modules/default/clock)
[Clock-module](https://github.com/MagicMirrorOrg/MagicMirror/tree/master/defaultmodules/clock)
could be customized by using the class `.clock`.

### Help
Expand Down