https://github.com/adammoses-github/mmm-collegefootballtop25

A module for the Magic Mirror to display the Top 25 College Football Teams based on the Associated Press Polling.
https://github.com/adammoses-github/mmm-collegefootballtop25

college football magicmirror rankings

Last synced: 4 months ago
JSON representation

A module for the Magic Mirror to display the Top 25 College Football Teams based on the Associated Press Polling.

• Host: GitHub
• URL: https://github.com/adammoses-github/mmm-collegefootballtop25
• Owner: AdamMoses-GitHub
• License: mit
• Created: 2018-08-15T00:46:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-22T20:44:24.000Z (almost 7 years ago)
• Last Synced: 2024-12-31T22:26:57.722Z (6 months ago)
• Topics: college, football, magicmirror, rankings
• Language: JavaScript
• Homepage:
• Size: 44.9 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Module: College Football Top 25

The `MMM-CollegeFootballTop25` module displays the Top 25 College Football Teams based on the Associate Press Polling.

Example:

![Full](images/example.jpg) 

## Dependencies / Requirements

This module requires the use of the `ap-top25-ncaaf` package for node.js. To install this please run `npm install ap-top25-ncaaf` from the MMM-CollegeFootballTop25 module directory inside your Magic Mirror installation directory.

## Operation

This module is straight-forward to use and requires no special configuration other than standard Magic Mirror positioning. 

To make a smaller, more efficent display, you can use the "teamsToShowAtATime" configuration option to limit the number of teams show at a time, and thus the height. Using less columns in the "columnOrder" configuration option will reduce the width. Changing the "textClass" value can increase or decrease the text size of the table.

All configuration options are optional, see below for more.

## Configuration options

The following properties can be configured:

	

	

		

			Option

			Description

		

	

		

		

			headerText

			String value, the header text to be shown above the rankings table. If set to '', then no header will be shown.


				
Example: 'AP Top 25'

				
Default value: 'College Football Top 25 Teams'

				
This value is OPTIONAL

			

				

		

			teamsToShowAtATime

			Integer value, this determines number of teams in the poll to show at a time. If 25, all teams will be shown. If less than 25, the specified number of teams will be shown before refreshing on screen to show the next number of teams, repeating until all teams have been shown. Well any number between 1 or 25 can be specified, using 5, 10, or 25 will yield best results.


				
Example: 5

				
Default value: 25

				
This value is OPTIONAL

			

		

		

			columnOrder

			List of strings values, where each string in the list is a column (a data point about that ranked team) in the poll. Available options are 'rank', 'name', 'conference', 'record', 'previous_rank', 'rank_change', and 'points'.  The columns will be rendered in the order specified in the list.


				
Example: [ 'rank_change', 'rank', 'name', 'record', 'conference', ]

				
Default value: [ 'rank', 'name', 'record', 'rank_change', ]

				
This value is OPTIONAL

			

		

		

			showColumnHeaders

			Boolean value, sets whether or not the column headers will be shown at the top of the table or not.


				
Example: false

				
Default value: true

				
This value is OPTIONAL

			

		   

		

			showPollWeekAndDate

			Boolean value, sets whether or to show the week and date of the poll, for instance "Week 3 - Sep 15". If set to true this value will be shown at the bottom right of the table.


				
Example: false

				
Default value: true

				
This value is OPTIONAL

			

		   		

        

			textClass

			String value, sets the class of the table body, i.e. what the text looks like. This class is set from the values in the Magic Mirror 'main.css' file.


				
Example: 'small'

				
Default value: 'xsmall'

				
This value is OPTIONAL

			

		

        

			maxTeamNameLength

			Integer value, the max length of a team name. Any name longer than this value will be truncated to this value and have a "..." added to it.


				
Example: 6

				
Default value: 16

				
This value is OPTIONAL

			

		      

        

			maxConferenceNameLength

			Integer value, the max length of a conference name. Any name longer than this value will be truncated to this value and have a "..." added to it.


				
Example: 8

				
Default value: 10

				
This value is OPTIONAL

			

		

		

			highlightTeams

			List of strings value. Each string in the list is two parts, a team name and a color value, seperated by a "::". The format is defined as "Team Name::#RRGGBB". If the team name part matches the ranked team name than the color value will be used across that row of the team instead of the usual color. Note that the specified team name must match the team name as dervied from the AP Top 25 Poll, so you may need to get some sample results before defining this.


				
Example: [ 'Virginia Tech::#6a2c3e', ]

				
Default value: [ ]

				
This value is OPTIONAL

			

			

		

			colorRankChange

			Boolean value, determines if the rank change column (the difference rank between this week and last week) should be colorized. If set to true will color increases in rank as green and decreases in rank as red.


				
Example: true

				
Default value: false

				
This value is OPTIONAL

			

		

		

			onScreenRefreshRate

			Integer value, the delay between changing the on-screen displayed teams for the next set. In milliseconds. Only used when the teamsToShowAtATime value is less than 25.


				
Example: 15000

				
Default value: 6000

				
This value is OPTIONAL

			

				

		

			animationSpeed

			Integer value, the animation speed sent to updateDom to fade in between new sets of on-screen teams. In milliseconds. Only used when the teamsToShowAtATime value is less than 25.


				
Example: 4500

				
Default value: 3000

				
This value is OPTIONAL