openCountdown/README.MD

1.4 KiB

openCountdown Logo

openCountdown

openCountdown is a professional software for event countdowns. It can be used in a live settings such as a music event. Support for companion is currently being worked on here.

Controllable by Companion

Installation

You can download complete binaries from the release tab.

Development build

  1. Download the repository
  2. npm install to install dependencies
  3. npm start to launch

Startup Arguments

One can pass a --headless argument to start the server in headless mode. This will disable the GUI.

Packaging

We've introduced a new packaging system. It is based on electron-builder. This allows for easy packaging of the application for different platforms.

chmod +x ./build.sh
./build.sh

Small disclaimer: Please do not use openCountdown for military or life-depending applications. Please also refrain from using openCountdown for launching rockets.

ToDo

Endpoint documentation is currently pretty thin. This will be changed in the future.

  • Endpoint docs (in Progress)
  • Better WS frames