Getting started
- Sören Oesterwind
In this article, we will get you started with openCountdown. From installation to setup.
Installation
We’ve simplified the installation process. In the past you had to compile the software yourself. However we now provide binary builds with every release.
Download a binary release fitting for your os from here
Unzip the file you just downloaded
This software is portable meaning you can put that folder anywhere you want (even on a USB)
We currently only support Windows x64 and Linux with your builds. This is because electron build behave differently on macOS. We will make a guide on running it yourself in the future.
Running the software
Starting the software is simple. Just double-click or start the opencountdown.exe file (or whatever file fits your system). A window will pop up with basic settings around the openCountdown server.
This launcher allows you to configure the port openCountdown is running on. Changing the port requires a restart of the application. Launch GUI will open the web interface in your default web browser. Hide will banish the application into your tray. Simply clicking the tray icon will reopen the launcher.
Main UI
The UI is made up out of multiple parts. The sidebar (1&2) and the main interface. The sidebar contains navigation to the settings and more information about the system. The sidebar also includes settings for dark/lightmode of the UI (2).
The next important part is the preview (3) which shows the current state of the timer. It also includes a function to open the full-screen timer page. Next to that, you can copy the link to your timer page.
(4) contains the mode select.
Mode | Description |
|---|---|
Timer | Shows the time remaining (and additional information if enabled) |
Clock | Shows the current time (like shown in the example screenshot) |
Testimage | Shows a test image (colorful bars) |
Screensaver | Shows a DVD-like screensaver (current time and logo bouncing around) |
(5) is important for timer controls. It allows you to start, pause and restart the current timer.
(6) is for messaging. You can send a message which will be displayed on the timer page like this:
The last remaining element is (7) which is the most integral part. This controls the timer. You can use one of the presets or set you own time. You may also use the date/time picker to select a time to countdown to. Though the timer will never show days.
The timer starts in an undefined state. It might show a big number initially.
Now you know everything you need to know for getting started with openCountdown!