Skip to content

A MagicMirror2 module that shows stats for Overwatch players.

License

Notifications You must be signed in to change notification settings

retroflex/MMM-Overwatch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MMM-Overwatch

A MagicMirror² module that shows player stats for Overwatch.

The stats are fetched from Ow-API (an unofficial Overwatch API). The link says Blizzard's API sometimes goes down and that will affect the API and this module as well.

screenshot

Installation

  1. Clone repo:
	cd MagicMirror/modules/
	git clone https://github.com/retroflex/MMM-Overwatch
  1. Install dependencies:
	cd MMM-Overwatch/
	npm install
  1. Add the module to the ../MagicMirror/config/config.js, example:
		{
			module: 'MMM-Overwatch',
			header: 'Overwatch',
			position: 'bottom_right',
			config: {
  		  userInfos: [ { platform: 'pc', battleTag: 'xappyFan1-2240' },
  	                 { platform: 'pc', battleTag: 'itsGGood-1256' } ],
			}
		},

Configuration

Option Description
showLevel Whether to show level column.
Default value: true
showRating Whether to show rating column.
Default value: true
showGamesWon Whether to show column with total games won (all game modes).
Default value: true
sortBy Which column to sort by. Possible values: 'level', 'rating' or 'gamesWon'.
Default value: rating
fetchInterval How often to fetch stats (milliseconds).
Default value: 10 * 60 * 1000 (every ten minutes)
userInfos Array of user info. Each item contains platform and battle tag.
Platform can be 'pc' etc. (this is how it's described in the API docs, so you'll have to figure out this yourself.
Note that the hash (#) in the battle tag must be replaced with a dash (-)!
Your battle tag can be found inside the game.
Default value: Fury-31609 + HanBin-31186.

Customize Looks

The following class names can be used in 'MagicMirror/css/custom.css' to customize looks (see MMM-Overwatch.css for example):

CSS name Description
header-row Header (whole row).
stats-row The players' stats (whole rows).
username-header Username header.
level-header Level header.
rating-header Rating header.
games-won-header Games won header.
level Level.
rating Rating.
games-won Games won (total for all game modes).

About

A MagicMirror2 module that shows stats for Overwatch players.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published