search

AdamMoses-GitHub / MMM-RottenTomatoes

A module for the Magic Mirror to display the Rotten Tomatoes meter score for the current box office and movies coming soon.
MIT License
9 stars 4 forks source link
films magicmirror movies ratings rotten rottentomatoes tomatoes

readme

Module: Rotten Tomatoes

The MMM-RottenTomatoes module is designed to, without any API keys, show movies that are ranking at the box office, opening this week, or coming soon. For each movies the Rotten Tomato meter score is shown (if available) as well as release date or box office gross.

Example:

Full

Dependencies / Requirements

This module requires the use of the rt-scraper package for node.js. To install this please run npm install rt-scraper from the MMM-RottenTomatoes module directory inside your Magic Mirror installation directory.

Operation

This module is straight-forward to use and requires no special configuration other than standard Magic Mirror positioning.

Optional configurations are available, see below for more.

Configuration options

The following properties can be configured:

Option Description
showHeader Boolean value, should a header be shown. If true, will show "Rotten Tomatoes".

Example: false
Default value: true
This value is OPTIONAL
showBoxOffice Boolean value, should the box office section be shown.

Example: false
Default value: true
This value is OPTIONAL
showOpeningThisWeek Boolean value, should the movies opening this week section be shown.

Example: false
Default value: true
This value is OPTIONAL
showComingSoon Boolean value, should the movies coming soon section be shown.

Example: false
Default value: true
This value is OPTIONAL
limitBoxOffice The number of movies to be shown in the box office listing. Setting to zero will show all available.

Example: 4
Default value: 3
This value is OPTIONAL
limitOpeningThisWeek The number of movies to be shown in the opening this week listing. Setting to zero will show all available.

Example: 4
Default value: 3
This value is OPTIONAL
limitComingSoon The number of movies to be shown in the coming soon listing. Setting to zero will show all available.

Example: 4
Default value: 3
This value is OPTIONAL
boxOfficeAfter Boolean value, should the box office listing be shown after the opening this week / coming soon sections. If set to false will be shown before.

Example: false
Default value: true
This value is OPTIONAL
mergeOpeningAndComingSoon Boolean value, should the opening this week and coming soon sections be merged or seperate.

Example: false
Default value: true
This value is OPTIONAL