Skip to content

Latest commit

 

History

History
58 lines (53 loc) · 3.04 KB

README.md

File metadata and controls

58 lines (53 loc) · 3.04 KB
Raw

MMM-Fortnite

A MagicMirror² module that shows Fortnite players' stats (score, matches played and kills). The stats shown are from all seasons and platforms.

The stats are fetched from this API (which seem to bit unstable at times).

screenshot

Installation

  1. Clone repo:
	cd MagicMirror/modules/
	git clone https://github.com/retroflex/MMM-Fortnite
  1. Install dependencies:
	cd MMM-Fortnite/
	npm install
  1. Add the module to the ../MagicMirror/config/config.js, example:
		{
			module: 'MMM-Fortnite',
			header: 'Fortnite',
			position: 'top_center',
			config: {
				showScore: false,
				sortBy: 'kills',
				userIDs: [ '4735ce9132924caf8a5b17789b40f79c', '3900c5958e4b4553907b2b32e86e03f8' ]
			}
		},

Configuration

Option Description
showScore Whether to show column with the user's total score.
Default value: true
showMatchesPlayed Whether to show column with the user's total number of matches played.
Default value: true
showKills Whether to show column with the user's total number of kills.
Default value: true
includeDefaultGameModes Whether to include default game modes (solo, duo, squad) in count.
Default value: true
includeLimitedTimeGameModes Whether to include limited time game modes (e.g. blitz, snipers etc.) in count.
Default value: true
includeLargeTeamGameModes Whether to include large team game modes (e.g. 50 vs 50) in count.
Default value: false
sortBy Which column to sort by. Possible values: 'score', 'matchesPlayed' or 'kills'.
Default value: score
fetchInterval How often to fetch stats (milliseconds).
Default value: 60 * 1000 (each minute)
userIDs Array of user ID's.
Use this URL to get the user ID from user name:
https://fortnite-public-api.theapinetwork.com/prod09/users/id?username=YOURUSERNAME
Default value: 4735ce9132924caf8a5b17789b40f79c (Ninja)

Customize Looks

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

CSS name Description
header-row Header (whole row).
stats-row The players' stats (whole rows).
username-header Username header.
score-header Score header.
matches-played-header Matches played header.
kills-header Kills header.
score Score.
matches-played Number of matches played.
kills Number of kills.