Skip to content
MagicMirror module to display wallpapers from various online sources
JavaScript CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE Fix name and year in license Apr 26, 2018
MMM-Wallpaper.css Use naturalWidth and naturalHeight of loaded images instead of relyin… Jan 16, 2019
MMM-Wallpaper.js Add maxWidth/maxHeight config options for limiting sizes of selected … May 14, 2019
README.md Add maxWidth/maxHeight config options for limiting sizes of selected … May 14, 2019
firetv.json Use naturalWidth and naturalHeight of loaded images instead of relyin… Jan 16, 2019
node_helper.js

README.md

Module: MMM-Wallpaper

The module allows you to add wallpapers from various online sources. Useful for MagicMirror installations that aren't actually mirrors.

Installation

In your terminal, go to your MagicMirror's Module folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/kolbyjack/MMM-Wallpaper.git

Configure the module in your config.js file.

Note: After starting the Mirror, it will take a few seconds before the wallpapers start to appear.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
  {
    module: "MMM-Wallpaper",
    position: "fullscreen_below",
    config: { // See "Configuration options" for more information.
      source: "bing",
      slideInterval: 60 * 1000 // Change slides every minute
    }
  }
]

Configuration options

The following properties can be configured:

Option Default Description
source "bing" The image source to use. Supported sources:
 - "bing": cycles through the most recent daily wallpapers from Bing
 - "firetv": cycles through random selections of the FireTV wallpapers
 - "/r/<subreddit>": cycles through the most recent "hot" image posts from the subreddit
 - "icloud:<album id>": cycles through random selections of the specified album
updateInterval 60 * 60 * 1000 How often (in ms) to check the source for new wallpapers.
slideInterval 5 * 60 * 1000 How often (in ms) to change images.
maximumEntries 10 The maximum number of images to switch between from the source.
filter "grayscale(0.5) brightness(0.5)" The CSS filter to apply to the images, to improve readability of other modules' text
orientation "auto" The image orientation to retrieve. Choices are "vertical," "horizontal," and "auto."
crossfade true Whether to crossfade between images when loading a new wallpaper, or just replace the current image.
maxWidth MAX_SAFE_INTEGER Maximum width of selected variant (only supported for reddit sources).
maxHeight MAX_SAFE_INTEGER Maximum height of selected variant (only supported for reddit sources).
You can’t perform that action at this time.