Mr-HaleYa/MMM-JokeAPI

A MagicMirror module that shows jokes from the JokeAPI

MagicMirror² JokeAPI module

This is a module for MagicMirror²; the purpose of the module is to show you jokes from the V2 JokeAPI.

Preview

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-JokeAPI',
    position: 'middle_center',
}

You can use more detailed configuration like these; See the below section.

{
    module: 'MMM-JokeAPI',
    position: 'middle_center',
    config: {
        lang: "en",
        category: "Programming,Miscellaneous",
        blacklistFlags: "nsfw",
        safeMode: true,
    }
}

Configuration options

Option	Description
category	Joke Categories. Possible values:Any, Miscellaneous, Dark, Programming, Pun, Spooky, Christmas Type: string Default value: Any Multiple catagories can be used at once, just seperate them with commas Example: category: "Programming,Miscellaneous,Pun",
fetchInterval	How often (in milliseconds) a new joke should be fetched. Type: number Default value: 10 * 1000
lang	Language the jokes are in. Current languages suported are cs, de, en, es, fr, pt Type: string Default value: en Example: lang: "en",
blacklistFlags	Prevent jokes of this type. These are all the available flags: nsfw, religious, political, racist, sexist, explicit Type: string Default value: NULL Multiple blacklistFlags can be set at one, just seperate them with commas Example: blacklistFlags: "nsfw,religious",
safeMode	If enabled, JokeAPI will try its best to serve only jokes that are considered safe for everyone. Unsafe jokes are those who can be considered explicit in any way, either through the used language, its references or its blacklist flags. Jokes from the category Dark are also generally marked as unsafe. Type: bool Default value: false Example: safeMode: true,

Credits

MagicMirror²: MagicMirror²
JokeAPI: V2 JokeAPI