https://github.com/omkarmoghe/nba-ticker

Adds live NBA scores for today's games in VS Code's status bar.
https://github.com/omkarmoghe/nba-ticker

nba scores vscode vscode-extension

Last synced: 8 months ago
JSON representation

Adds live NBA scores for today's games in VS Code's status bar.

• Host: GitHub
• URL: https://github.com/omkarmoghe/nba-ticker
• Owner: omkarmoghe
• License: mit
• Created: 2020-08-19T09:15:16.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T17:35:40.000Z (over 1 year ago)
• Last Synced: 2025-02-03T16:23:15.957Z (9 months ago)
• Topics: nba, scores, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 99.2 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# NBA Ticker 🏀

![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/omkarmoghe.nba-ticker?label=Release)

Adds live NBA scores for today's games in your status bar using the data.nba.net API.

![Status bar ticker](https://i.imgur.com/EfQzKgb.gif)

![Game details](https://i.imgur.com/dW8HKoh.png)

![Scoreboard](https://i.imgur.com/QAJuS9T.png)

## Requirements

- VSCode must have a working internet connection.

## Installation

Install via the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=omkarmoghe.nba-ticker).

## Settings

All settings are prefixed by with `nba-ticker.`, so `side` becomes `"nba-ticker.side"` when editing as JSON.

### `format`

Specifies how the game info should be displayed. Defaults to `"${vTeam} ${vScore} - ${hScore} ${hTeam}, ${status}"`, which looks like `GSW 42 - 24 LAL, 4:20 1st`. The available wildcards are:

- `${vTeam}`: The visiting team's abbreviated name, (e.g. `"GSW"`)

- `${vScore}`: The visiting team's score

- `${hTeam}`: The home team's abbreviated name, (e.g. `"LAL"`)

- `${hScore}`: The home team's score

- `${status}`: The status of the game

  - If the game hasn't started yet, this will be the scheduled start time (e.g. `"9:30 PM"`) in your local UTC offset.

  - If the game is ongoing, this will be either `" "` (e.g. `"4:20 1st"`), `"End of 1st"`, or `"Halftime"`

  - If the game is over, this will be `"Final"`

  - If the status is unknown, this will be `"TBD"`

### `hideFinalScores`

If checked, final scores will be hidden from the status bar. Final scores will always be visible in the status bar hover when the `hover` option is set to `scoreboard`. Defaults to `false`.

### `hover`

Specifies what to show when hovering over the ticker. Options are `"details"` (details about the current game) or `"scoreboard"` (all scores).

### `pollDelaySeconds`

Specifies how long to wait before fetching new game data from the API. Defaults to `60` seconds, i.e. every minute. Allowed values are [`10`, `600`].

### `priority`

Specifies the ticker's priority relative to other items in the status bar. **Higher values are shows more to the left.**

### `side`

Specifies which side of the status bar to display the ticker. Options are `"left"` or `"right"`.

### `teamFilter`

Specifies which teams games are shown for; other teams are ignored. All teams will be shown if the array is empty (`[]`). **Use abbreviated team names** (e.g. `["GSW", "LAL"]`).

### `tickerDelaySeconds`

Specifies how many seconds to show each score. Defaults to `10` seconds. Allowed values are [`1`, `60`].

## FAQ

### How fast is "live"?

- All versions >= `0.3.0` (including current): scores update as fast as the data.nba.net API.

- For versions < `0.3.0`: scores update every ~10 minutes.

## [Changelog](./CHANGELOG.md)

## Credits

- Versions before `0.3.0` were built using the amazing [balldontlie API](https://www.balldontlie.io/#introduction). If you like this extension, please consider [donating](https://www.patreon.com/balldontlie) to them.

- Icon by [Cahya Kurniawa](https://www.iconfinder.com/sikeystudio) via [Iconfinder](https://www.iconfinder.com/).