From fb0373083d75016e14a77225c78b05cb7f6c2364 Mon Sep 17 00:00:00 2001 From: Chuck <33324927+ChuckBuilds@users.noreply.github.com> Date: Wed, 2 Sep 2026 14:00:42 -0400 Subject: [PATCH] docs(afl-scoreboard): document the settings the rewrite dropped Auditing my own baseball rewrite turned up the same failure mode in the AFL one that already merged: reorganising the README lost content. Comparing every config token the old file mentioned against the new one found two settings gone entirely, plus a framing error. other_games_min_quality and other_games_divisions were not documented at all. Both are now, together with the fact that neither does anything in this league: 'ranked' needs a national poll the AFL does not publish, so the filter passes every game and no poll is requested; the divisions filter needs ESPN's FBS/FCS group rosters, which exist for college football and nothing else. Also records that favourites are never filtered by either, and that both fail open. The framing error is worth more than the omissions. upcoming_games_to_show is a pool the panel cycles through one card at a time, keeping its place between visits -- so raising it lengthens the lap and any one game comes round LESS often. The README implied the opposite, which would send someone tuning it in exactly the wrong direction. Also restores the debug-logging tip for finding an unfamiliar team abbreviation, and a manual-installation section. Co-Authored-By: Claude Opus 5 --- plugins.json | 2 +- plugins/afl-scoreboard/README.md | 61 ++++++++++++++++++++++++---- plugins/afl-scoreboard/manifest.json | 9 +++- 3 files changed, 61 insertions(+), 11 deletions(-) diff --git a/plugins.json b/plugins.json index 610c1736..780feb6c 100644 --- a/plugins.json +++ b/plugins.json @@ -1048,7 +1048,7 @@ "downloads": 0, "verified": true, "screenshot": "", - "latest_version": "1.19.2", + "latest_version": "1.19.3", "last_updated": "2026-09-02" }, { diff --git a/plugins/afl-scoreboard/README.md b/plugins/afl-scoreboard/README.md index a2fa9830..33f97b0c 100644 --- a/plugins/afl-scoreboard/README.md +++ b/plugins/afl-scoreboard/README.md @@ -17,14 +17,15 @@ real 2026 finals series.* ## Table of Contents 1. [What's On Screen](#whats-on-screen) -2. [Quick Start](#quick-start) -3. [How Games Are Picked](#how-games-are-picked) +2. [Installation](#installation) +3. [Quick Start](#quick-start) +4. [How Games Are Picked](#how-games-are-picked) - [The three selection modes](#the-three-selection-modes) - [What the "games to show" numbers mean](#what-the-games-to-show-numbers-mean) - [Which games exist to pick from](#which-games-exist-to-pick-from) - [Live games and priority](#live-games-and-priority) - [Seeing live games more often in the Vegas ticker](#seeing-live-games-more-often-in-the-vegas-ticker) -4. [Configuration Reference](#configuration-reference) +5. [Configuration Reference](#configuration-reference) - [Teams and filtering](#teams-and-filtering) - [Display modes and rotation](#display-modes-and-rotation) - [How long things stay on screen](#how-long-things-stay-on-screen) @@ -34,12 +35,12 @@ real 2026 finals series.* - [Celebrations](#celebrations) - [Fonts, colours and offsets](#fonts-colours-and-offsets) - [Timezone](#timezone) -5. [Panel Sizes](#panel-sizes) -6. [Team Abbreviations](#team-abbreviations) -7. [Known Limitations](#known-limitations) -8. [Troubleshooting](#troubleshooting) -9. [Development](#development) -10. [Support](#support) +6. [Panel Sizes](#panel-sizes) +7. [Team Abbreviations](#team-abbreviations) +8. [Known Limitations](#known-limitations) +9. [Troubleshooting](#troubleshooting) +10. [Development](#development) +11. [Support](#support) --- @@ -63,6 +64,17 @@ a separator like `at` or `@` reads correctly as "away at home". --- +## Installation + +**From the Plugin Store (recommended).** Open the LEDMatrix web interface at +`http://:5000`, go to **Plugin Manager**, find **AFL Scoreboard** +in the **Plugin Store** section, and click **Install**. + +**Manually.** Copy this directory into your LEDMatrix `plugins_directory` +(default `plugin-repos/`) and restart the display service. + +--- + ## Quick Start The minimum useful configuration is your teams: @@ -152,6 +164,26 @@ board works through the round rather than resampling the front of it. Set > `favorite_teams` is empty, the favourites filter is skipped entirely and you > get mode 1 — every game. An empty favourites list never means "show nothing". +### Two settings that do nothing in this league + +`other_games_min_quality` and `other_games_divisions` filter which *non-favourite* +games earn a slot in the favourites-first path. Both come from the shared sports +engine, and neither has anything to work with here: + +- `other_games_min_quality: "ranked"` needs a national poll. The AFL publishes + none, so the filter lets every game through and no poll is requested. +- `other_games_divisions: ["fbs"]` needs ESPN's FBS/FCS group rosters, which + exist for **college football and nothing else**. Asked for any other league + they come back empty, so no lookup is made. + +Your favourite teams are never filtered by either setting in any case — they +only decide what fills the remaining slots. Leave both at their defaults. + +Both filters also **fail open**: if the data behind them cannot be fetched the +game is allowed through, and if they would between them leave nothing at all, +the unfiltered list is used instead. Setting `other_upcoming_games_to_show` to +`0` is the one way to ask for favourites only, and that is honoured. + ### What the "games to show" numbers mean `upcoming_games_to_show` and `recent_games_to_show` change meaning depending on @@ -167,6 +199,12 @@ plugin's configuration: So with three favourite teams and `upcoming_games_to_show: 3`, exclusive mode can produce up to nine cards, while the other two modes produce three. +**And it is a pool size, not a card count.** The panel shows one game at a time +and keeps its place between visits, cycling through the pool. Raising +`upcoming_games_to_show` therefore gives you a *longer lap* — any one game comes +round **less** often, not more. To see your team's next game more, make the +number smaller. + `exclude_teams` is applied on top of all of this and beats everything — a team listed there is hidden from the live rotation and from recent scores even if it is also a favourite. That is what makes it useful for spoiler protection. @@ -336,6 +374,8 @@ also driving a panel, and raising the polling rate rarely helps. | `other_recent_games_to_show` | `1` | **Advanced.** Non-favourite recent games, in "favourites first" mode | | `other_upcoming_games_to_show` | `1` | **Advanced.** Non-favourite upcoming games, in "favourites first" mode | | `other_rotation_interval_seconds` | `1800` | **Advanced.** How often the non-favourite window advances | +| `other_games_min_quality` | `ranked` | **Advanced.** Which non-favourite games earn a slot: `any` or `ranked`. **Inert for AFL** — see below | +| `other_games_divisions` | `["fbs"]` | **Advanced.** Which divisions non-favourite games may come from. **Inert for AFL** — see below | | `show_records` | `false` | **Advanced.** Draw each team's season record in the bottom corners | | `show_ranking` | `false` | **Advanced.** Draw a rank badge. AFL publishes no poll, so this shows nothing | | `show_odds` | `true` | Draw the betting line. **ESPN publishes no odds for AFL** — see [Known Limitations](#known-limitations) | @@ -498,6 +538,9 @@ name: ESPN's team list also exposes a stale `GCFC` entry mislabelled as "Sydney Swans". Use `SUNS` for Gold Coast. +If you are ever unsure of a code, enable debug logging: the plugin logs +`home_abbr` and `away_abbr` for every game it processes. + --- ## Known Limitations diff --git a/plugins/afl-scoreboard/manifest.json b/plugins/afl-scoreboard/manifest.json index d341ebac..5ee31fdf 100644 --- a/plugins/afl-scoreboard/manifest.json +++ b/plugins/afl-scoreboard/manifest.json @@ -1,7 +1,7 @@ { "id": "afl-scoreboard", "name": "AFL Scoreboard", - "version": "1.19.2", + "version": "1.19.3", "author": "ChuckBuilds", "description": "Live, recent, and upcoming AFL (Australian Football League) games with real-time scores and game status.", "category": "sports", @@ -18,6 +18,13 @@ "afl_upcoming" ], "versions": [ + { + "version": "1.19.3", + "released": "2026-09-02", + "ledmatrix_min_version": "3.2.0", + "notes": "Documentation only. Fills gaps left by the previous README rewrite. Documents other_games_min_quality and other_games_divisions, which the rewrite dropped entirely, and records that both are inert in this league: 'ranked' needs a national poll the AFL does not publish, and the divisions filter needs ESPN's FBS/FCS group rosters, which exist for college football and nothing else. Adds that both filters fail open and that favourites are never filtered by either. Corrects the framing of upcoming_games_to_show: it is a pool the panel cycles through one card at a time, so raising it makes any one game come round less often, not more. Restores the debug-logging tip for finding team abbreviations and a manual-installation section.", + "changelog": "Documentation only. Fills gaps left by the previous README rewrite. Documents other_games_min_quality and other_games_divisions, which the rewrite dropped entirely, and records that both are inert in this league: 'ranked' needs a national poll the AFL does not publish, and the divisions filter needs ESPN's FBS/FCS group rosters, which exist for college football and nothing else. Adds that both filters fail open and that favourites are never filtered by either. Corrects the framing of upcoming_games_to_show: it is a pool the panel cycles through one card at a time, so raising it makes any one game come round less often, not more. Restores the debug-logging tip for finding team abbreviations and a manual-installation section." + }, { "version": "1.19.2", "released": "2026-09-02",