Skip to content

Commit

Permalink
Merge pull request #451 from tracerrx/update_readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
ty-porter authored Apr 7, 2023
2 parents 4b18ba0 + bf4ad92 commit 20e25f4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# mlb-led-scoreboard

![Current Version](https://img.shields.io/github/v/release/MLB-LED-Scoreboard/MLB-LED-Scoreboard) [![Join Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://join.slack.com/t/mlb-led-scoreboard/shared_invite/zt-1f6n4axo4-r32OH7dlSAjEjstFV4RDNQ)
![Current Version](https://img.shields.io/github/v/release/MLB-LED-Scoreboard/MLB-LED-Scoreboard) [![Join Discord](https://img.shields.io/badge/discord-join-blue.svg)](https://discord.gg/FdD6ec9fdt)
[![Join Slack](https://img.shields.io/badge/slack-join%20(deprecated)-blue.svg)](https://join.slack.com/t/mlb-led-scoreboard/shared_invite/zt-1f6n4axo4-r32OH7dlSAjEjstFV4RDNQ)

<a href="assets/img/header.jpg">
<img alt="Project header" width="800px" height="auto" src="assets/img/header.jpg">
Expand Down Expand Up @@ -248,6 +249,12 @@ A default `config.json.example` file is included for reference. Copy this file t
"demo_date" String A date in the format YYYY-MM-DD from which to pull data to demonstrate the scoreboard. A value of `false` will disable demo mode.
```

### Delaying Board Update
* The "preferred_game_update_delay_in_10s_of_seconds" will delay the update of your LED board to allow you to synchronize with the boroadcast feed.
* You can only delay the board in 10 second increments, so a value of 3 coresponds to 30 seconds, 5 to 50 seconds etc.
* There appears to be a lot of variability in broadcast delays across networks/teams/CDN's.
* Please note, that if restarting the service with a delay, it will take the value of cycles set for the board to be in sync. If you set the value to 3, it will take 30-40 seconds for the buffer to fill and the board to delay.

### Additional Features
* Runs/Hits/Errors - Runs are always shown on the games screen, but you can enable or adjust spacing of a "runs, hits, errors" display. Take a look at the [coordinates readme file](/coordinates/README.md) for details.

Expand Down
2 changes: 2 additions & 0 deletions coordinates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ The software develops and releases features with full support for the default la
A couple of things are not completely implemented or have some implementation details you should understand.

* `bases` currently requires an even `size` value to be rendered correctly
* Not all options are enabled on all board sizes by default. For example pitch count and pitch type are not enabled by default on boards smaller than 64x64. Options are "disabled" by forcing them to render outside the board, by setting X and Y coordinates less than 0 or greater than the height or width of the board.

0 comments on commit 20e25f4

Please sign in to comment.