A React powered Countdown Timer for use with CasparCG includes theme support.
Branch: master
Clone or download
Pull request Compare This branch is 22 commits ahead of sneat:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
casparcg_output
src
.babelrc
.gitignore
LICENSE.md
gulpfile.js
package.json
readme.md
template_settings.png

readme.md

countdown_timer

Installation

  1. Install Node.js
  2. Install Gulp
    • npm install --global gulp
  3. Install required packages
    • npm install
  4. Run gulp to list available comments
    • gulp
  5. Run gulp build the build using the provided theme
    • gulp build --theme mediary

Folder structure

  • casparcg_output
    • Copy the contents of this folder onto the CasparCG server
  • src
    • This is where the source to the CasparCG template lives. If you want to make changes to the Countdown Timer, this is where you should do it

Themes

Theme support is available. To make a new theme, duplicate an existing theme (e.g. "base") from the ./src/themes directory and then make any required adjustments. Most likely you'll be wanting to edit ./src/themes/<theme_name>/css/styles.less to edit the font size, add a background image etc.

  • base
    • css any css/less files in this directory will be merged into ./casparcg_output/css/main.css
      • styles.less the main styles for the theme
    • images any files in this directory will be copied into ./casparcg_output/images
    • js any js files in this directory will be merged into ./casparcg_output/js/main.js
    • lib.json Use this file to list any additional third-party libraries that you want to include. They will be copied as is into the appropriate build directory.
      • any other folder will be copied into ./casparcg_output

CasparCG Client Settings

Times should be passed through using either the f0 or time key as number of seconds, or using the "HH:MM:SS" or "MM:SS" format.

By default the template will hide itself at the end of the countdown, you can pass through 0 or false to the f1 or hideOnEnd key to keep the template visible.

By default the timer counts down. You can pass through 1 or true to the f2 or countUp key to have it count up instead. In this mode it will keep counting forever until you take it offline.

Debugging and Creating a New Theme

While the primary purpose of the countdown-timer is for use with CasparCG, you don't need to copy the changes to a CasparCG server each time you adjust a theme. You can view your changes by simply opening the compiled source (./casparcg_output/countdown_timer.html) in a modern browser (e.g. Chrome - since CasparCG is built on an old Chrome version).