Skip to content

Latest commit

 

History

History
executable file
·
74 lines (63 loc) · 2.35 KB

Readme.md

File metadata and controls

executable file
·
74 lines (63 loc) · 2.35 KB

Documentation

This MagicMirror2 module named MMM-RocketLeagueZ displays cross-platform stats (rank,MMR) of the popular computer game Rocket League.

You can choose for which gamertags, platforms and playlists you want to get stats for.

RocketLeagueZ_png

Install

  1. Change the directory to MagicMirror/modules: $ cd MagicMirror/modules
  2. Clone this repo: $ git clone https://github.com/Zeprakadebra/MMM-RocketLeagueZ
  3. List the contents of MagicMirror/modules to make sure that MMM-RocketLeagueZ was cloned: $ ls
  4. Change the directory to MagicMirror/config: $ cd ~/MagicMirror/config
  5. Modify your config.js file and add the MMM-RocketLeagueZ module: $ sudo nano config.js

Config Settings

The basic config should look like this

{
    module: "MMM-RocketLeagueZ",
    position: "top_center",
    config: {}
},

If everything runs as expected you can customize the config param based on the table below.

Param Default Value Type Definition
gamers - Array of str This param array is used to define the gamertags and platform to get the stats for. The array consists of string pairs of a platform code followed by a gamertag seperated by '/', e.c. 'xbl/foo'. Following platform codes are available: xbl = XBOX, psn = PLAYSTATION, steam = STEAM, epic = EPIC, switch = NINTENTO.
playlists ['Un-Ranked', 'Ranked Duel 1v1', 'Ranked Doubles 2v2', 'Ranked Standard 3v3', 'Tournament Matches'] Array of str This param array is used to define the playlists to get display stats for. The array consists of strings of the origin playlists names.
baseURL https://api.tracker.gg/api/v2/rocket-league/standard/profile/ str This is the api to fetch stats from.
fetchInterval 600000 int This is how frequently you want to fetch stats from the baseURL.
rotateInterval 10000 int This is how frequently you want to rotate through the different playlists
animationSpeed 400 int This is how fast you want to animate between playlist rotation