Project-Name-Here/openCountdown
3
0
Fork 0
Code Issues Pull Requests Releases 6 Wiki Activity
16a2549942
openCountdown/README.MD

1.4 KiB
Raw Blame History

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 dependecies
  3. node index.js to launch

Packaging

This is more a comment for the future version of me. There is one command for packaging using nexe.

npx nexe index.js --build --python python3 --resource "./{lang,templates,static}/**/*" --ouput "openCountdown.exe”

Where --python is only needed in some envoirments for some reason. Also adjust --output for your target OS.

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