Skip to content

Commit

Permalink
add image, alphabetize commands in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlecM33 committed Aug 10, 2024
1 parent 92c074d commit 575b27c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,24 @@ When running, the bot periodically polls for games in a 48-hour window centered
the "current" game, and will be the game for which a lot of the commands returns data. If there's a doubleheader, the bot may ask you to specify which game. If a game is live, the bot subscribes to its MLB.com Gameday live feed,
and in turn reports events to any number of subscribed Discord channels. Slash Commands include:

- **/starters** - look at the starting pitching matchup for the current game. Includes portraits of both starters, their W/L, ERA, and WHIP, and a list of the pitches they throw.
- **/standings** - check the standings for your team's division.
- **/lineup** - view the lineup card for the current game.
- **/line_score** - view the line score for the current game.
- **/attendance** - view the attendance for the current game.
- **/batter** - view stats on a specified batter. If you don't provide a name, the bot will check for a live game and use the current batter.
- **/batter_savant** - view Baseball Savant percentile rankings for a specified batter. If you don't provide a name, the bot will check for a live game and use the current batter.
- **/box_score** - view the box score for the current game, including hitting and pitching stats.
- **/scoring_plays** - get a curated list of scoring plays, with direct links to the play on the Gameday page.
- **/highlights** - get a direct link to the "game story", which is MLB's timeline of key moments.
- **/subscribe_gameday** - subscribe a given Discord channel to receive real-time updates from the "Gameday" feed. This command is restricted to certain roles. Users can adjust which plays the bot reports and customize a reporting delay. The message includes a description of the play, any change in score, and statcast metrics for balls in play.
- **/unsubscribe_gameday** - un-subscribe a given Discord channel from the above functionality.
- **/gameday_preference** - change the preference for the gameday subscription. This includes which types of plays to report ("all plays" or "scoring plays only") and a reporting delay of 0-180 seconds.
- **/schedule** - view the upcoming schedule for the next week of games.
- **/batter** - view stats on a specified batter. If you don't provide a name, the bot will check for a live game and use the current batter.
- **/highlights** - get a direct link to the "game story", which is MLB's timeline of key moments.
- **/lineup** - view the lineup card for the current game.
- **/line_score** - view the line score for the current game.
- **/pitcher** - view stats on a specified pitcher. If you don't provide a name, the bot will check for a live game and use the current pitcher.
- **/batter_savant** - view Baseball Savant percentile rankings for a specified batter. If you don't provide a name, the bot will check for a live game and use the current batter.
- **/pitcher_savant** - view Baseball Savant percentile rankings for a specified pitcher. If you don't provide a name, the bot will check for a live game and use the current pitcher.
- **/schedule** - view the upcoming schedule for the next week of games.
- **/scoring_plays** - get a curated list of scoring plays, with direct links to the play on the Gameday page.
- **/standings** - check the standings for your team's division.
- **/starters** - look at the starting pitching matchup for the current game. Includes portraits of both starters, their W/L, ERA, and WHIP, and a list of the pitches they throw.
- **/subscribe_gameday** - subscribe a given Discord channel to receive real-time updates from the "Gameday" feed. This command is restricted to certain roles. Users can adjust which plays the bot reports and customize a reporting delay. The message includes a description of the play, any change in score, and statcast metrics for balls in play.
- **/unsubscribe_gameday** - un-subscribe a given Discord channel from the above functionality.
- **/weather** - view the weather for current the game.
- **/attendance** - view the attendance for the current game.
- **/wildcard** - check the standings for your team's division.

...and likely more to follow!

Expand Down
Binary file added docs/images/screenshots/wildcard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ <h2 class="command-header">/highlights</h2>
<img class="bot-demo-img" alt="highlights" src="./images/screenshots/highlights.png"/>
<h2 class="command-header">/standings</h2>
<img class="bot-demo-img" alt="standings" src="./images/screenshots/standings.png"/>
<h2 class="command-header">/wildcard</h2>
<img class="bot-demo-img" alt="wildcard" src="./images/screenshots/wildcard.png"/>
<h2 class="command-header">/schedule</h2>
<img class="bot-demo-img" alt="schedule" src="./images/screenshots/schedule.png"/>
<h2 class="command-header">/weather</h2>
Expand Down

0 comments on commit 575b27c

Please sign in to comment.