search

pcurt / MMM-BlaguesAPI

MIT License
1 stars 0 forks source link

readme

MagicMirror² BlaguesAPI module

This is a module for MagicMirror²; the purpose of the module is to show you jokes from the french BlaguesAPI (https://www.blagues-api.fr).

Installation

  1. Clone this repository into your MagicMirror modules folder.
  2. Edit your configuration file under config/config.js with the following configuration. 
    {
module: 'MMM-BlaguesAPI',
position: 'bottom_bar',
type: {
    type: "random",
    fetchInterval: 60000,
    blaguesApiToken: "xxxxx"
}
}

Preview

Screenshot

Configuration options

Option Description
type The list of module names that are controlled by this module.
Possible values:
1. global
2. dev
3. dark
4. limit
5. beauf
6. blondes

Type: string
Default value: random
fetchInterval How often (in milliseconds) a new joke should be fetched.

Type: number
Default value: 60 * 1000
blaguesApiToken Your API Token generated on https://www.blagues-api.fr

Type: string

Credits

MagicMirror²: MagicMirror²
BlaguesAPI: BlaguesAPI