Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 4.02 KB

File metadata and controls

78 lines (52 loc) · 4.02 KB

🎯 Scoreboard Engine

What is Scoreboard Engine?

  • 𖣘 engine - A high-performance, real-time scoreboard backend built with Rust, Axum, and Tokio with integrated web dashboard.
  • 🦾 companion-module-scoreboard-engine - A module for BitFocus Companion supporting all features.

Dashboard Screenshot

Quick Links

Key Features

  • Single-Binary: Single executable, built in rust for speed and robustness.
  • Automations: Trigger any action on scoreboard conditions (see Wiki: Automations).
  • Customisable: Assemble your scoreboard from a collection of widgets and an XML configuration.
  • Integrated Dashboard: A HTML dashboard is baked directly into the executable.
  • Disaster Recovery: Live state is persisted on every change and tick.
  • SSE Support: Get every tick and every change in realtime via HTTP Server Sent Events.
  • Live Audit: Every action is time-stamped in match_log.txt and mirrored to the stdout console.
  • JSON Data Source: Link to vMix titles using Data Sources
  • Javascript Helper: Included Javascript helper library for easy HTML title creation.
  • Static Server: Serve custom HTML titles from a folder for use in OBS and as a web source/input.

If you find this useful - buy me a Ko-Fi.

Available Widgets

See the wiki page Widgets for documentation on each widget.

Ready to run configurations, companion pages and HTML scorebug for

Quickstart

Yes, I know these instructions could be better!

These quickstart instructions are for getting up and running quickly using the precompiled binary version of the latest release.

Engine

  • Download the latest version from the Github repository releases. There is precompiled binaries there for Windows, Linux & Mac.
  • Extract the archive to any location on your computer.
  • Copy/edit/create a config.xml to match your requirements.
  • Run scoreboard-engine (or scoreboard-engine.exe on windows)
  • Open your dashboard http://localhost:3000

To install the Bitfocus Companion module see the Bitfocus Companion page on our Wiki

Quickstart Integration Guides

The quickstart guides have moved to the wiki