Skip to content

docs(baseball-scoreboard): document every setting, with a real live scorebug #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChuckBuilds merged 2 commits into from
Sep 2, 2026
Merged

docs(baseball-scoreboard): document every setting, with a real live scorebug #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0aa4bf4
docs(baseball-scoreboard): document every setting, with a real live s…
ChuckBuilds Sep 2, 2026
0348991
docs(baseball-scoreboard): restore detail the rewrite dropped
ChuckBuilds Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ curl -X POST http://your-pi-ip:5000/api/v3/plugins/install \
| [Football Scoreboard](./plugins/football-scoreboard/) | NFL & NCAA Football live scores, down/distance, possession | |
| [Hockey Scoreboard](./plugins/hockey-scoreboard/) | NHL & NCAA Hockey live scores and schedules | |
| [Basketball Scoreboard](./plugins/basketball-scoreboard/) | NBA, NCAA & WNBA live scores and schedules | |
| [Baseball Scoreboard](./plugins/baseball-scoreboard/) | MLB, MiLB & NCAA Baseball live scores | |
| [Baseball Scoreboard](./plugins/baseball-scoreboard/) | MLB, MiLB & NCAA Baseball live scores | <a href="./plugins/baseball-scoreboard/"><img src="./docs/assets/baseball-scoreboard/hero.png" width="240" alt="baseball-scoreboard on an LED panel"></a> |
| [Soccer Scoreboard](./plugins/soccer-scoreboard/) | Premier League, La Liga, Bundesliga, Serie A, Ligue 1, MLS | |
| [Lacrosse Scoreboard](./plugins/lacrosse-scoreboard/) | NCAA lacrosse live scores and schedules | |
| [Cricket Scoreboard](./plugins/cricket-scoreboard/) | Live, recent & upcoming international (Test/ODI/T20I) and major domestic cricket | |
Expand Down
Binary file added docs/assets/baseball-scoreboard/display-modes.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/baseball-scoreboard/fixtures/live-today.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/baseball-scoreboard/fixtures/season-schedule.json
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added docs/assets/baseball-scoreboard/hero.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/baseball-scoreboard/panel-sizes.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
301 changes: 301 additions & 0 deletions docs/assets/baseball-scoreboard/shots.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,301 @@
{
"plugin": "baseball-scoreboard",
"defaults": {
"width": 128,
"height": 32,
"scale": 6,
"freeze_time": "2026-09-02T17:50:00+00:00",
"mock_data": "fixtures/season-schedule.json",
"http_replay": "fixtures/live-today.json",
"config": {
"enabled": true,
"timezone": "America/New_York",
"milb": {
"enabled": false
},
"ncaa_baseball": {
"enabled": false
},
"mlb": {
"enabled": true,
"favorite_teams": [],
"filtering": {
"show_favorite_teams_only": false,
"show_all_live": true
},
"display_options": {
"show_records": false,
"show_odds": false
},
"recent_games_to_show": 1,
"upcoming_games_to_show": 1
}
}
},
"shots": [
{
"name": "hero",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
}
},
{
"name": "mode-live",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"standalone": false
},
{
"name": "mode-recent",
"config": {
"mlb": {
"display_modes": {
"show_live": false,
"show_recent": true,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"standalone": false
},
{
"name": "mode-upcoming",
"config": {
"mlb": {
"display_modes": {
"show_live": false,
"show_recent": false,
"show_upcoming": true,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"standalone": false
},
{
"name": "size-64x32",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"width": 64,
"height": 32,
"scale": 8,
"standalone": false
},
{
"name": "size-128x32",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"width": 128,
"height": 32,
"scale": 8,
"standalone": false
},
{
"name": "size-128x64",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"width": 128,
"height": 64,
"scale": 8,
"standalone": false
},
{
"name": "size-256x32",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
}
}
},
"width": 256,
"height": 32,
"scale": 4,
"standalone": false
},
{
"name": "records-off",
"config": {
"mlb": {
"display_modes": {
"show_live": false,
"show_recent": true,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
},
"display_options": {
"show_records": false
}
}
},
"standalone": false
},
{
"name": "records-on",
"config": {
"mlb": {
"display_modes": {
"show_live": false,
"show_recent": true,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
},
"display_options": {
"show_records": true
}
}
},
"standalone": false
},
{
"name": "traditional",
"config": {
"mlb": {
"display_modes": {
"show_live": true,
"show_recent": false,
"show_upcoming": false,
"live_display_mode": "switch",
"recent_display_mode": "switch",
"upcoming_display_mode": "switch"
},
"display_options": {
"show_traditional_scoreboard": true
}
}
},
"width": 128,
"height": 64,
"scale": 6,
"standalone": false
}
],
"composites": [
{
"name": "display-modes",
"columns": 1,
"cells": [
{
"shot": "mode-live",
"label": "mlb_live",
"sublabel": "score, inning, bases, outs and the count"
},
{
"shot": "mode-recent",
"label": "mlb_recent",
"sublabel": "final score of a completed game"
},
{
"shot": "mode-upcoming",
"label": "mlb_upcoming",
"sublabel": "date and first pitch, in your timezone"
}
]
},
{
"name": "panel-sizes",
"columns": 1,
"cells": [
{
"shot": "size-64x32",
"label": "64 x 32",
"sublabel": "logos behind the text; score keeps priority"
},
{
"shot": "size-128x32",
"label": "128 x 32",
"sublabel": "the common two-panel chain"
},
{
"shot": "size-128x64",
"label": "128 x 64",
"sublabel": "extra height separates the bands"
},
{
"shot": "size-256x32",
"label": "256 x 32",
"sublabel": "a long chain"
}
]
},
{
"name": "show-records",
"columns": 1,
"cells": [
{
"shot": "records-off",
"label": "show_records: false",
"sublabel": "the default"
},
{
"shot": "records-on",
"label": "show_records: true",
"sublabel": "each team's win-loss record in the bottom corners"
}
]
}
]
}
Binary file added docs/assets/baseball-scoreboard/show-records.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"last_updated": "2026-09-02",
"verified": true,
"screenshot": "",
"latest_version": "1.37.1"
"latest_version": "1.37.2"
},
{
"id": "basketball-scoreboard",
Expand Down
Loading
Loading