Skip to content

Conversation

@ty-porter
Copy link
Contributor

@ty-porter ty-porter commented Apr 5, 2025

This is a breaking change and requires a major version update.

We have a config validator that will prevent old configs from completely bombing, but writing these as deprecations (such as #427 and #602) will take a long time and increase the code complexity, I prefer to just rip the bandaid off with a major version bump in this case

Changelog

  • config.json

    • pregame_weather moved to weather section (weather.pregame)
    • removed full_team_names (moved to coordinates)
    • removed short_team_names_for_runs_hits (moved to coordinates)
    • renamed preferred_game_delay_multiplier to sync_delay_seconds and significantly altered its functionality
      • This setting is now the TOTAL desired delay and the number of responses stored in the delay buffer is equal to this setting divided by API refresh rate plus 1
      • This simplifies end users calculating their desired sync
  • coordinates/wXhY.json

    • added teams.name.full boolean
      • Replaces removed full_team_names from config.json
      • Defaults to true:
        • 128x32
        • 128x64
        • 192x64
        • 64x32
        • 64x64
      • Defaults to false:
        • 32x32
    • added teams.name.shorten_on_high_line_score boolean
      • Replaces removed short_team_names_for_runs_hits from config.json
      • All sizes default to true
    • Changed teams.runs section to teams.line_score
      • Moved all teams.runs.runs_hits_errors subkeys to the teams.line_score section
        • ex: teams.runs.runs_hits_errors.compress_digits is now teams.line_score.compress_digits
      • Renamed teams.runs.runs_hits_errors.show to teams.line_score.show_hits_and_errors
      • Values are left unchanged

Fix coord keypath name

Fix wordy config setting

Update README

Change how the delay buffer setting works, update README

Change how the delay buffer setting works, update README

Clarify line score

Revert some old README fixes

Fix bad merge

Remove unused constant
@ty-porter ty-porter marked this pull request as ready for review October 25, 2025 02:04
@ty-porter ty-porter merged commit 06ff725 into dev Nov 3, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants