k4kfh / casparcg-html-templates

Some examples and a framework to start from when developing templates for CasparCG's HTML producer.
GNU General Public License v3.0
18 stars 9 forks source link

CasparCG HTML Templates

Some examples and a framework to start from when developing templates for CasparCG's HTML producer.

CasparCG HTML Producer Quick Reference

Note: This project is a work in progress. Some templates may be unfinished or unstable. If you encounter broken templates, bugs, or other issues, please make a GitHub issue so that we know about it. And of course, pull requests welcome.

Getting Started

It's important to note that while some of these templates can be used as finished products, this repo is more intended as a starting point for you to develop your own templates. Every creative team will have different needs, but using simple JavaScript/HTML/CSS that is familiar to many creative/web developer types, you can customize the templates to your heart's content.

That said, there are a few things to consider:

Installation

To "install" these templates, simply clone this repository and drag the contents of the templates folder into the templates folder on your CasparCG server. Then you can open the templates in your favorite web development program, such as Brackets.io.

Developing Templates

Some basic JavaScript/HTML/CSS knowledge is required to use these tools. If you want to learn, Codecademy is a great place to get an introduction, and W3Schools also provides excellent resources. And of course, some general computer knowledge is required as well.

Bottom line: be sure to read the comments in the files, they are there to help. And it would also be helpful for you to read this blog post, where I explain what all the JavaScript functions CasparCG calls are for.