Skip to content

A Status Board of a currently running match, best shown on a large screen in fullscreen mode

License

Notifications You must be signed in to change notification settings

RoboCup-SSL/ssl-status-board

Repository files navigation

CircleCI Go Report Card Go Doc Release Coverage

SSL Status Board

A Status Board for the Small Size League, optimized to show the current game state on a large screen.

Adding your teams logo

If you would like to see your teams logo on the status-board, add it to frontend/src/assets/logos and include it in frontend/src/helpers/teamLogo.ts. The team name must match the one configured in the ssl-game-controller in all lowercase.

Usage

If you just want to use this app, simply download the latest release binary. The binary is self-contained. No dependencies are required.

You can also use pre-build docker images:

docker pull robocupssl/ssl-status-board
docker run -p 8082:8082 robocupssl/ssl-status-board

By default, the UI is available at http://localhost:8082

A configuration file will be generated to config/board-config.yaml and can be tweaked.

A website (like Youtube) can be displayed when there is no activity. Pass the URL like this: http://localhost:8082??showVideoAfter=420&url=https%3A%2F%2Fwww.youtube.com%2Fembed%2F364zEAsOclU%3Fstart%3D0%26autoplay%3D1%26mute%3D1%26loop%3D1%26playlist%3D364zEAsOclU

Runtime Requirements

  • No software dependencies (except for development, see below)
  • 64bit Linux, Windows, OSX (build your 32bit binaries yourself...)
  • A reasonable Web-Browser (mostly tested on Chrome)

Development

Requirements

You need to install following dependencies first:

  • Go
  • Node

See .circleci/config.yml for compatible versions.

Frontend

See frontend/README.md

Build

Build and install all binaries:

make install

Run

Build and run main binary:

make run

Releases

You can find all published releases on the Releases page of this repository. Each release contains pre-built binaries (for major platforms). To get up and running quickly, follow the steps below:

  1. Navigate to Releases at https://github.com/RoboCup-SSL/ssl-status-board/releases.

  2. Find the version you want and download the asset labelled something like ssl-status-board_<version>_<os-arch>

  3. On Linux/MacOS/Windows, open a terminal and run the binary You might need to mark it executable on Linux/Mac:

chmod +x <file>

About

A Status Board of a currently running match, best shown on a large screen in fullscreen mode

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 32