Skip to content

mmlTools/fly-scoreboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

128 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ† Fly Scoreboard - OBS Studio Plugin (2025 Edition)

A modern, teamโ€‘agnostic, autoโ€‘updating scoreboard overlay for OBS Studio.
Fly Scoreboard now uses a fully flexible team_x / team_y architecture, dynamic custom fields, multiple timers, live swapping, and a clean browser-based overlay powered by a lightweight builtโ€‘in web server.

Support on Ko-fi


๐Ÿ–ผ๏ธ Preview

Fly Scoreboard Preview


โœจ Features

๐Ÿ†• 2025 Engine (team_x / team_y)

  • Flexible team order (swap dynamically)
  • Custom fields mapped to x/y values (no more home/away hardcoding)
  • Future-proof overlay structure for any sport or event

Core Features

  • ๐Ÿ• Multiโ€‘Timer System
    Count up/down, pause, reset, extra timers, and synchronized overlay updates.
  • ๐Ÿ Dock Controls
    Adjust scores, fields, timers, and visibility instantly.
  • ๐ŸŽฎ Hotkey Support
    Bind keys for +1/โˆ’1, swap teams, start/pause/reset timers, and show/hide scoreboard.
  • ๐ŸŒ Web Overlay
    Lightweight auto-generated overlay served locally with seamless live updates.
  • ๐Ÿž๏ธ Logos & Branding
    Upload team logos; plugin handles hashing, copying, and cacheโ€‘safe filenames.
  • ๐Ÿงน Reset Tools
    Clear team info, reset fields, delete logos, restore defaults in one click.
  • โš™๏ธ Settings Dialog
    Configure server port, open overlay folder, enable/disable health check, etc.

โšก No dependencies besides OBS SDK + Qt. Fast, safe, and extremely lightweight.


๐Ÿ“ฆ Installation

โœ” Recommended - Download Release ZIP

  1. Download the latest release:
    https://github.com/mmlTools/fly-scoreboard/releases
  2. Extract into OBS plugins directory:
    C:\Program Files\obs-studio\obs-plugins4bit   ```
    
  3. Restart OBS โ†’ View โ†’ Docks โ†’ Fly Scoreboard.

๐Ÿ›  Building From Source

Windows (Visual Studio 2022)

cmake -S . -B build -G "Visual Studio 17 2022" -A x64 ^
  -DENABLE_FRONTEND_API=ON -DENABLE_QT=ON -DCMAKE_COMPILE_WARNING_AS_ERROR=OFF

cmake --build build --config Release
cmake --install build --config Release --prefix "E:\obs-studio"

Linux / macOS

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release   -DENABLE_FRONTEND_API=ON -DENABLE_QT=ON

cmake --build build --config Release
sudo cmake --install build

๐Ÿง  How to Use

  1. Open Dock โ†’ Fly Scoreboard
  2. Edit:
    • Team names, subtitles, logos
    • Custom numeric fields
    • Timers (main match timer + extra timers)
  3. Toggle Show/Hide Scoreboard
  4. Overlay updates instantly in OBS Browser Source

๐ŸŽน Hotkeys

Found in FlyScore โ†’ Hotkeys:

  • Team X Score +1 / โˆ’1
  • Team Y Score +1 / โˆ’1
  • Swap Teams (team_x โ†” team_y)
  • Timer: Start / Stop / Reset
  • Toggle Scoreboard Visibility

๐ŸŒ Overlay Setup

The overlay is served from:

http://127.0.0.1:<port>/index.html

If not auto-created, add a Browser Source manually using that address.

State is stored here:

<config_path>/plugin.json

This includes:

  • team_x / team_y data
  • custom field values
  • timers
  • visibility flags
  • logo paths (hashed)
  • web server config

๐Ÿ“ Project Structure

โ”œโ”€โ”€โ”€data
โ”‚   โ”œโ”€โ”€โ”€locale
โ”‚   โ”‚       en-US.ini
โ”‚   โ”‚       ro-RO.ini
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€โ”€overlay
โ”‚           index.html
โ”‚           script.js
โ”‚           style.css
โ”‚
โ”œโ”€โ”€โ”€docs
โ”‚   โ”‚   index.html
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€โ”€assets
โ”‚       โ”œโ”€โ”€โ”€css
โ”‚       โ”‚       style.css
โ”‚       โ”‚
โ”‚       โ”œโ”€โ”€โ”€img
โ”‚       โ”‚       logo.svg
โ”‚       โ”‚       preview.webp
โ”‚       โ”‚
โ”‚       โ””โ”€โ”€โ”€js
โ”‚               app.js
โ”‚
โ”œโ”€โ”€โ”€installer
โ”‚   โ”‚   fly-scoreboard-installer.nsi
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€โ”€resources
โ”‚           fly-scoreboard-welcome.bmp
โ”‚           fly-scoreboard.ico
โ”‚
โ””โ”€โ”€โ”€src
    โ”‚   fly_score_dock.cpp
    โ”‚   fly_score_fields_dialog.cpp
    โ”‚   fly_score_hotkeys_dialog.cpp
    โ”‚   widgets.cpp
    โ”‚   fly_score_logo_helpers.cpp
    โ”‚   fly_score_obs_helpers.cpp
    โ”‚   fly_score_paths.cpp
    โ”‚   fly_score_plugin.cpp
    โ”‚   fly_score_qt_helpers.cpp
    โ”‚   server.cpp
    โ”‚   fly_score_settings_dialog.cpp
    โ”‚   fly_score_state.cpp
    โ”‚   fly_score_teams_dialog.cpp
    โ”‚   fly_score_timers_dialog.cpp
    โ”‚
    โ”œโ”€โ”€โ”€include
    โ”‚       config.hpp
    โ”‚       config.hpp.in
    โ”‚       fly_score_const.hpp
    โ”‚       fly_score_dock.hpp
    โ”‚       fly_score_fields_dialog.hpp
    โ”‚       fly_score_hotkeys_dialog.hpp
    โ”‚       widgets.hpp
    โ”‚       fly_score_log.hpp
    โ”‚       fly_score_logo_helpers.hpp
    โ”‚       fly_score_obs_helpers.hpp
    โ”‚       fly_score_paths.hpp
    โ”‚       fly_score_qt_helpers.hpp
    โ”‚       server.hpp
    โ”‚       fly_score_settings_dialog.hpp
    โ”‚       fly_score_state.hpp
    โ”‚       fly_score_teams_dialog.hpp
    โ”‚       fly_score_timers_dialog.hpp
    โ”‚
    โ””โ”€โ”€โ”€thirdparty
            httplib.h

๐Ÿค Contributing & Support


๐Ÿ“œ License

MIT License ยฉ 2025 MMLTech
Built with โค๏ธ using OBS Studio, Qt, and a lot of caffeine.

About

A lightweight, hotkey-friendly scoreboard overlay for OBS Studio designed for live sports, esports, and streaming events. It runs a local web server that powers an auto-updating browser overlay, allowing real-time updates via dock controls or hotkeys.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages