Live Sports Scores - VS Code Extension
Never miss a match while you code. Stay connected to the games that matter.
🎯 What is Live Sports Scores?
Live Sports Scores transforms VS Code into your personal sports command center. Whether you're debugging code or following your favorite teams, this extension keeps you connected to live football (soccer) and cricket matches directly in your development environment.
The Problem
You're in the zone coding, but you don't want to miss that crucial goal, wicket, or match-winning moment. Constantly switching tabs or checking your phone breaks your flow.
The Solution
Live Sports Scores brings live sports directly into VS Code with real-time updates, a beautiful dashboard, and a status bar that shows scores at a glance—all without leaving your editor.
✨ Features
📊 Status Bar Integration
- Live Score Display - See the top live football or cricket match right in your status bar
- Smart Prioritization - Football matches take priority, with cricket as fallback
- One-Click Access - Click the status bar to open the full dashboard
- Match Pinning - Pin your favorite match to always see it in the status bar
- Real-Time Updates - Scores refresh automatically based on your configured interval
🎮 Tabbed Dashboard
⚙️ Fully Configurable
- Customizable refresh intervals (10-300 seconds)
- Enable/disable cricket scores
- Configure favorite football competition
- Show/hide status bar
- Control maximum cricket matches displayed
🚀 Quick Start Guide
⚠️ API Keys Required
Important: The extension can be installed and will run without API keys, but you need at least one API key to see actual scores.
- Without API keys: Extension works but shows empty states and warnings
- With Football API key only: You'll see football scores
- With Cricket API key only: You'll see cricket scores
- With both API keys: You'll see both football and cricket scores
You need at least one API key to get started! Both APIs offer free tiers, so getting started is quick and easy.
Step 1: Install the Extension
- Open VS Code Extensions (
Ctrl+Shift+X / Cmd+Shift+X)
- Search for "Live Sports Scores"
- Click Install
Note: After installation, the extension will work but won't show scores until you configure at least one API key (see steps below).
Get Your API Key
Configure in VS Code
- Open Settings (
Ctrl+, / Cmd+,)
- Search for "Live Sports Scores"
- Set
footballLiveScores.apiKey to your API key
- Set
footballLiveScores.favoriteCompetitionId (e.g., 2021 for Premier League)
Step 3: Set Up Cricket Scores (Optional)
Note: Cricket setup is optional. If you only want football scores, you can skip this step.
Get Your API Key
Configure in VS Code
- In Settings, set
footballLiveScores.cricketApiKey to your API key
- Ensure
footballLiveScores.enableCricket is enabled (default: true)
Step 4: Start Using
After configuring at least one API key, you can start using the extension:
Open the Dashboard
- Click the status bar item, OR
- Use Command Palette (
Ctrl+Shift+P / Cmd+Shift+P) → "Sports: Open Live Scores Dashboard"
View Live Matches
- Browse the Football and Cricket tabs
- See real-time scores updating automatically
- Pin matches you want to track in the status bar
Refresh Manually
- Click the "Refresh" button in the dashboard, OR
- Use Command Palette → "Sports: Refresh Live Scores"
📋 Supported Sports & Leagues
| Sport |
Status |
Coverage |
API Source |
| ⚽ Football (Soccer) |
✅ Live |
All competitions from football-data.org |
football-data.org |
| 🏏 Cricket |
✅ Live |
Current matches worldwide |
cricketdata.org |
- Premier League (ID: 2021)
- La Liga (ID: 2014)
- Bundesliga (ID: 2002)
- Serie A (ID: 2019)
- Ligue 1 (ID: 2015)
- Champions League (ID: 2001)
- And many more! Check football-data.org for full list.
⚙️ Configuration
All settings are available in VS Code Settings (Ctrl+, / Cmd+,) under "Live Sports Scores".
Available Settings
| Setting |
Type |
Default |
Description |
footballLiveScores.apiKey |
string |
"" |
API key for football-data.org (required for football) |
footballLiveScores.favoriteCompetitionId |
number |
2021 |
Default competition ID (2021 = Premier League) |
footballLiveScores.refreshInterval |
number |
30 |
Polling interval in seconds (10-300) |
footballLiveScores.showStatusBar |
boolean |
true |
Show status bar item |
footballLiveScores.enableCricket |
boolean |
true |
Enable cricket live scores |
footballLiveScores.cricketApiKey |
string |
"" |
API key for cricketdata.org (required for cricket) |
footballLiveScores.cricketMaxMatches |
number |
10 |
Maximum cricket matches to display |
Example Configuration
{
"footballLiveScores.apiKey": "your-football-api-key-here",
"footballLiveScores.favoriteCompetitionId": 2021,
"footballLiveScores.refreshInterval": 30,
"footballLiveScores.showStatusBar": true,
"footballLiveScores.enableCricket": true,
"footballLiveScores.cricketApiKey": "your-cricket-api-key-here",
"footballLiveScores.cricketMaxMatches": 10
}
🎮 Commands
Access via Command Palette (Ctrl+Shift+P / Cmd+Shift+P):
- Sports: Open Live Scores Dashboard - Opens the main dashboard with Football and Cricket tabs
- Sports: Refresh Live Scores - Manually refresh all scores
❓ Frequently Asked Questions
Do I need API keys to use this extension?
Short answer: The extension will install and run without API keys, but you need at least one API key to see actual scores.
Detailed answer:
- ✅ Extension installation: Works without API keys
- ✅ Extension functionality: Extension runs without crashing
- ❌ Showing scores: Requires at least one API key (football OR cricket)
- ⚠️ Without API keys: You'll see empty states and warnings like "Set footballLiveScores.apiKey" or "No live matches"
To see scores, you need:
- Football API key → See football scores
- Cricket API key → See cricket scores
- Both API keys → See both sports
Both APIs offer free tiers, so getting started is quick and easy!
Can I use the extension with only one API key?
Yes! You can use the extension with just a football API key or just a cricket API key. The extension will show scores for whichever sport(s) you have configured. If you only have a football API key, the cricket tab will show an empty state, and vice versa.
The extension will:
- ✅ Install successfully
- ✅ Show the status bar item
- ✅ Open the dashboard when clicked
- ⚠️ Display warnings in the status bar ("Set footballLiveScores.apiKey")
- ⚠️ Show empty states in the dashboard tabs
- ❌ Not fetch or display any scores
Are the API keys free?
Yes! Both APIs offer free tiers:
- football-data.org: Free tier available (registration required)
- cricketdata.org: Free tier available (registration required)
Check their respective websites for current free tier limits and features.
Do I need to add API keys to the project code?
No! You configure API keys through VS Code Settings, not in the project code. The extension reads API keys from VS Code's configuration system, which stores them securely in your user settings. You never need to modify the extension's source code.
🔧 Development
Prerequisites
- Node.js v16+
- VS Code latest version
- TypeScript knowledge (optional)
Build from Source
# Clone the repository
git clone https://github.com/AkshayanMohandas/vscode-live-scores.git
cd vscode-live-scores
# Install dependencies
npm install
# Compile TypeScript
npm run compile
# Watch mode (auto-compile on changes)
npm run watch
# Run in development mode
# Press F5 in VS Code to launch Extension Development Host
Project Structure
vscode-live-scores/
├── 📁 src/
│ └── extension.ts # Main extension logic
├── 📁 media/
│ ├── dashboard.css # Dashboard styles
│ ├── dashboard.js # Dashboard JavaScript
│ ├── icon.png # Extension icon
│ └── sports.svg # Dashboard icon
├── 📁 out/ # Compiled JavaScript
├── package.json # Extension manifest
├── tsconfig.json # TypeScript configuration
└── README.md # This file
API Integration
💡 Use Cases
For Developers
- Stay Connected - Follow matches while coding without context switching
- Quick Checks - Glance at status bar for instant score updates
- Productivity - No need to leave your editor to check scores
- Multi-Tasking - Code and follow sports simultaneously
For Sports Fans
- Multi-Sport Tracking - Football and cricket in one place
- Real-Time Updates - Live scores that refresh automatically
- Clean Interface - Focused dashboard without distractions
- Persistent Tracking - Status bar always visible
For Teams
- Game Day Monitoring - Track important matches during work
- Team Events - Follow team matches and competitions
- Sports-Themed Environment - Fun productivity tool
- Shared Workspace - Team members can follow the same matches
🤝 Contributing
We welcome contributions! Here's how you can help:
Ways to Contribute
- 🐛 Report Bugs - Help us squash issues
- 💡 Suggest Features - Tell us what you want to see
- 🔧 Submit PRs - Code contributions are always welcome
- 📖 Improve Docs - Help others understand the project
- ⭐ Star the Repo - Show your support
Development Setup
# Fork and clone
git clone https://github.com/AkshayanMohandas/vscode-live-scores.git
# Create feature branch
git checkout -b feature/amazing-feature
# Make changes and test
npm run compile
# Press F5 in VS Code to test
# Submit PR
git push origin feature/amazing-feature
📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
- football-data.org for providing football data APIs
- cricketdata.org for providing cricket data APIs
- VS Code team for the amazing extension platform
- Open source community for inspiration and tools
- Sports fans everywhere for the motivation to build this
🏆 Ready to Never Miss a Match Again?
Install Live Sports Scores today and transform your VS Code into the ultimate sports command center!
Download Now → Search "Live Sports Scores" in VS Code Extensions
Happy coding and may your teams always win! 🚀⚽🏏
🐛 Found a Bug? 💡 Have an Idea?
Help make Live Sports Scores better! Report issues, suggest features, or share your feedback.
