compacted config type

This commit is contained in:
Edward Shen 2018-05-07 13:10:42 -04:00
parent f4fc53fa19
commit 14d4913a87
No known key found for this signature in database
GPG key ID: 4E887A42793D0433

View file

@ -50,13 +50,13 @@ modules: [
## Configuration options ## Configuration options
Option |Type |Default Value |Description Option |Type |Default Value |Description
---------------|-----------------------------------------------------------|------------------------|--------- ---------------|------------------|------------------------|-----------
`modules` |`[ [String, String, ...],`<br>`[String, String, ...], ...]`|`[]` |A 2D String array of what each module should be on which page. Notethat all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. `modules` |`[[String...]...]`|`[]` |A 2D String array of what each module should be on which page. Notethat all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix.
`excludes` |`[ String, String, ... ]` |`["MMM-page-indicator"]`|Which modules should show up all the time. `excludes` |`[String...]` |`["MMM-page-indicator"]`|Which modules should show up all the time.
`animationTime`|`int` |`1000` |Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). `animationTime`|`int` |`1000` |Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds).
`rotationTime` |`int` |`0` |Time, in milliseconds, between automatic page changes. `rotationTime` |`int` |`0` |Time, in milliseconds, between automatic page changes.
`delayTime` |`int` |`0` |Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. `delayTime` |`int` |`0` |Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time.
For the `module` configuration option, the first element of the outer array For the `module` configuration option, the first element of the outer array
should consist of elements that should be on the first page. The second element should consist of elements that should be on the first page. The second element