Skip to content

Hazeolation/Streaming-Tool

DSB Streaming Tool

Real-time overlay suite for Splatoon live streams - originally built for the Deutsche Splatoon Bundesliga (DSB).

Overlays run as Browser Sources in OBS and are controlled through a dedicated Control Panel. All data updates in real-time via SignalR.

Angular ASP.NET Core SQLite SignalR
Build .NET CI Build Node.js CI
Run .NET Tests CI Run Node.js Tests CI E2E Tests


Table of Contents


Quickstart

There are start scripts for both Windows and Linux/macOS. They check for required dependencies (Node.js, .NET 9 SDK), start the frontend and backend, and open the Control Panel in your browser automatically.

Platform Script
Windows start.bat, start.exe
Linux / macOS start.sh

Note

The scripts will prompt you to install missing dependencies via WinGet (Windows) or your system package manager (Linux/macOS).

Manual Start

Start frontend and backend manually

Backend

  1. Open Backend/DSB.StreamBackend/DSB.StreamBackend.csproj in Visual Studio.
  2. Start the project - the server runs on https://localhost:{port} (exact URL shown in the output window).
  3. Swagger UI is available at /swagger.

Frontend

cd Frontend/control-panel
npm install
npm start

Angular serves on http://localhost:4200. The Control Panel is at the root URL; overlays are accessible at their respective routes (see Overlay Routes).

Important

The backend must be running for overlays to receive live updates via SignalR.


Technical Documentation

For in-depth technical documentation, see the docs/ folder.

Tech Stack

Layer Technology
Frontend Angular (Control Panel + Overlays)
Backend ASP.NET Core 9, SignalR, SQLite

Overlay Routes (HTTP)

Route Description
/overlay/score-box Score display for both teams during matches
/overlay/map-screen Map overview
/overlay/commentator-box Commentator names
/overlay/info-box General info box
/overlay/start-screen Start screen with team names and countdown timer
/overlay/end-screen End screen with Discord and Twitter/X socials

How to Use

Note

This guide uses OBS Studio. Other broadcasting tools may behave slightly differently.

  1. Start the DSB Streaming Tool - see Quickstart. The frontend runs on http://localhost:4200.

  2. Open OBS Studio.

  3. Add a new Browser Source - in the Sources panel, click the + icon and select Browser.

  4. Enter the overlay URL. Each overlay has its own route (see Overlay Routes). For example, to add the score box:

http://localhost:4200/overlay/score-box
  1. Set the resolution to match your canvas (typically 1920 × 1080).

  2. Click OK - the overlay will appear in your scene and update in real-time as you control it from the Control Panel.

To control scores, maps, commentators, and other overlay data, open the Control Panel in your browser at:

http://localhost:4200/

Screenshots

Control Panel
Control Panel

Score-Box Overlay
Score-Box

Info-Box Overlay
Info-Box

Map Overview Overlay
Map Overview

Map Overview Overlay (With Counterpicks) Map Overview Counterpicks

Start Screen Start Screen

End Screen End Screen


Contributing

Contributions are welcome - whether you are a first-time coder or an experienced developer.

Warning

Please do not use AI-generated code or assets. AI-generated images and other assets will be rejected.

See CONTRIBUTING

Pull Request Process

Every pull request is reviewed by the maintainers defined in the CODEOWNERS file.

Contributor Role
@Hazeolation Original Maintainer, Head of Decisions
@iLollek Original Contributor - ReleaseNoteGenerator, Frontend & Backend
@RubberDuckCollector Original Contributor - Frontend & Backend
@BucketRaphi Original Contributor - Frontend

Repository Language Rules

Scope Language
Code & Documentation English
Comments English
UI Texts German

How to Support

If you like this Project, please leave a star! ⭐


Credits

Name Description
@CrispyNugget99 Created Designs for the UI

About

The Repository for the DSB Streaming tool.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors