/MMM-Chess-Daily

Display your chess.com games on your Magic Mirror using this module

Primary LanguageJavaScriptMIT LicenseMIT

MMM-Chess-Daily

This is a module for the MagicMirror². You can use this module to list your https://chess.com daily games, either as a simple list, or by displaying actual chess board(s).

You can customize this module.
Limit the number of boards (or don't show any boards at all), alter the updating interval, and most importantly, pick a nice theme
MMM-Chess-Daily impression
(You can show as many boards as you like.)                                                                                                                                                                                                        

Using the module

There are three steps to get this module up and running:

  1. cd MagicMirror/modules/, followed by git clone https://github.com/nout-kleef/MMM-Chess-Daily.git
  2. cd MMM-Chess-Daily, followed by npm install (this installs the chess-web-api Node module)
  3. add the following configuration block to the modules array in the config/config.js file:
var config = {
    modules: [
        {
		module: 'MMM-Chess-Daily',
		header: "my chess games",
		position: "top_right",
		config: {
                	username: "<YOUR_USERNAME>",
                	maxGames: 2,
                	maxBoards: 2,
			theme: "classic"
		}
	}
    ]
}

Configuration options

OptionDescription
username Required you don't need an API key - simply put your (or anyone else's) username here.
Type: string
Default: ""
updateInterval Optional how often do we update the games
Type: int (milliseconds)
Default: 60000 (one minute)
maxGames Optional how many games to list
NB: ordered first by whether it is your turn, then by how much time is left
NB: use any negative value to display all of your current games.
Type: int
Default: 5
maxBoards Optional how many boards to show
Type: int
Default: 1
highlightLastMove Optional highlight the newest move
Type: boolean
Default: true
theme Optional Pick a theme for your chess pieces.
Type: string
Default: "classic"
All themes that are available on chess.com are supported:
"8_bit" "alpha" "bases"
"book" "bubblegum" "blindfold" (probably not the most sensible choice!)
"cases" "classic" "club"
"condal" "dash" "game_room"
"glass" "gothic" "graffiti"
"icy_sea" "light" "lolz"
"marble" "maya" "metal"
"modern" "nature" "neon"
"neo" "neo_wood" "newspaper"
"ocean" "sky" "space"
"tigers" "tournament" "vintage"
"wood" "3d_wood" "3d_staunton"
"3d_plastic" "3d_chesskid"

Contributing

If you want to improve this module, you may find the following documentation helpful: https://www.npmjs.com/package/chess-web-api