2022-07-23 18:15:14 +02:00
<img alt="openCountdown Logo" height="90px" src="https://git.project-name-here.de/Project-Name-Here/openCountdown/raw/branch/master/static/logo/logoProposal.svg">
2022-07-23 18:15:01 +02:00
2022-02-24 20:17:24 +01:00
# openCountdown
2022-07-15 17:29:43 +02:00
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](https://github.com/bitfocus/companion-module-pnh-opencountdown).
2022-07-15 23:59:48 +02:00
<a href="https://bitfocus.io/companion/?ref=pnh-Opencountdown" target="_new"><img alt="Controllable by Companion" src="https://bitfocus.io/companion-badge.png?ref=pnh-Opencountdown"></a>
2022-07-15 17:32:12 +02:00
# Installation
You can download complete binaries from the release tab.
## Development build
1. Download the repository
2. `npm install` to install dependecies
2022-08-18 22:00:24 +02:00
3. `npm start` to launch
2022-07-15 17:32:12 +02:00
2022-08-18 22:00:24 +02:00
### Startup Arguments
One can pass a `--headless` argument to start the server in headless mode. This will disable the GUI.
2022-07-15 18:40:30 +02:00
## Packaging
This is more a comment for the future version of me. There is one command for packaging using nexe.
```bash
2022-07-23 18:15:14 +02:00
npx nexe index.js --build --python python3 --resource "./{lang,templates,static}/**/*" --ouput "openCountdown.exe”
2022-07-15 18:40:30 +02:00
```
Where `--python` is only needed in some envoirments for some reason. Also adjust `--output` for your target OS.
2022-10-28 18:43:08 +02:00
> Binary Builds may be faulty or non-working. They are not offically supported.
2022-07-15 17:29:43 +02:00
*Small disclaimer: Please do not use openCountdown for military or life-depending applications. Please also refrain from using openCountdown for launching rockets.*
2022-02-24 20:17:24 +01:00
# ToDo
2022-07-15 17:29:43 +02:00
Endpoint documentation is currently pretty thin. This will be changed in the future.
2022-07-15 17:30:03 +02:00
- [ ] Endpoint docs (in Progress)
2022-03-28 22:14:33 +02:00
- [ ] Better WS frames
