Scoreko

Broadcast graphics for fighting games
Download · Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Standalone Version
   • Building from Source
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Scoreko is a robust broadcast graphics system designed for fighting game tournaments.

Features include:

• Scoreboard and commentator overlays
• start.gg and challonge integration for fetching players
• Dynamic game asset packs downloading via remote repositories
• Standalone executable (.exe) wrapper with Electron for non-developers

(back to top)

Built With

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

You can run Scoreko using the standalone executable (easiest method) or build it from source.

Standalone Version (Recommended)

For non-developers and those looking for a quick setup, Scoreko offers a standalone executable wrapped in Electron.

1. Download the latest .exe from the Releases page
2. Run the executable. The NodeCG server and dashboard will automatically start and open in an Electron window.

Building from Source

If you want to modify the source code or run it manually via Node.js:

Prerequisites

• Node.js and npm
• Git

Installation

1. Clone the repo:

   git clone https://github.com/Pandipipas/scoreko.git

2. Install NPM packages:

   cd scoreko
   npm ci

3. Build the project:

   npm run build

4. Start NodeCG:

   npx nodecg start

(back to top)

Usage

Once the server is running (either via the .exe or via source), access the dashboard to control the overlays. If using the source version, open http://localhost:9090.

Importing overlays into OBS

Scoreko includes a built-in system to easily import your overlays:

• Open the Graphics tab in the Scoreko dashboard.
• Drag and Drop: Click and drag from the provided button directly into OBS to automatically create the Browser Source.
• Copy URL: Alternatively, you can copy the URL and create a new Browser Source in OBS manually.

When configuring the Browser Source in OBS, ensure you set:

• Width to 1920 and Height to 1080
• FPS to 60
• Check "Shutdown source when not visible"
• Check "Refresh browser when scene becomes active"

Themes

You can customize the appearance of the overlays directly from the dashboard by selecting from a variety of different themes for the scoreboard.

(back to top)

Troubleshooting

Slow Startup / First Boot

If you are using the Standalone Version and the application takes a long time to start on the very first boot, this is completely normal. Scoreko extracts thousands of files for its internal environment, and some Antivirus software (such as Windows Defender) scans each file individually during extraction. Subsequent launches will be much faster.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Twitter Profile - GitHub Profile

Project Link: https://github.com/Pandipipas/scoreko

(back to top)