Skip to content

Latest commit

 

History

History
162 lines (107 loc) · 5.87 KB

README.md

File metadata and controls

162 lines (107 loc) · 5.87 KB
Raw

HTML Template builder

GitHub release (latest by date) Maintenance Last commit Python version

Template builder is a simple tool that assembles HTML snippet, SASS stylesheet, and JavaScript file into a graphic template for CasparCG, or another HTML-enabled playout server.

It aims to be as simple as possible, it does not use any JS framework and does not need several gigabytes of node dependencies.

Out of the box, it provides:

  • CSS reset: transparent background, overflow settings, font smoothing, box-sizing etc.
  • Debug mode to display log messages directly in the graphics output
  • JavaScript parse_params function for parsing arguments coming from CasparCG via the UPDATE call
  • JavaScript amcp function which enables sending AMCP command to a running CasparCG instance using http2amcp bridge

Installation

To run the software from source, Python 3.6 or higher must be installed. You also need pip to install third-party libraries.

Linux

Clone this repository and install the required python libraries using the following command:

pip3 install -r requirements.txt

Windows

Use the same procedure as with Linux or download the latest binary package from the releases page.

Usage

See the example in the src/ directory.

Template source

For each template, create a directory in the source root (defaults to ./src). The name of the directory is the template name. In the template directory, create the following files:

manifest.json

Template manifest provides metadata, information about editable fields, and external javascript requirements.

Using a js element in the manifest you can specify additional javascript files to be used in the resulting template. Specified files/URLs will be linked using <script> tags in the HTML header.

template.html

HTML snippet which will be added to the template body

template.sass

SASS file will be compiled to CSS and will be embedded (along with base style) to the resulting HTML file. Base stylesheet (core/core.sass) is always included first and resolves page transparency, box-sizing, margins, body overflow, and so on.

template.js

Template logic. Within the JavaScript file, you may use the following bundled functions:

parse_params

parse_params is a helper used in update function. It parses an incoming string from CasparCG client/automation, which may be an XML or JSON and returns a javascript object:

function update(data){
    var params = parse_params(data);
    if ("header-text" in params){
        document.getElementById("header-text").innerHTML = params["header-text"];
    }
}
amcp

You can use a this function to control the playout server. http2amcp bridge must be running.

amcp("MIXER 1-1 FILL .25 .25 .5 .5");

Additional files

Along with template source files and the manifest, a template directory may contain additional files, such as javascript libraries, images, etc.

Builder copies these files automatically to the build folder.

Building

Run build.py (build.exe) without arguments to build all templates in the source root directory and exit.

You may also pass the following additional parameters:

--watch / --no-watch   Watch the source directory and rebuild templates when
                       source files are changed  [default: False]

--dist / --no-dist     Also generate zip files containing finished
                       template(s)  [default: False]

--template TEXT        When specified, build/watch only the selected
                       template and ignore the rest

--src-dir DIRECTORY    Path to the source root directory  [default: ./src]
--build-dir DIRECTORY  Path to the output directory  [default: ./build]
--dist-dir DIRECTORY   Path to the directory where resulting zip files will
                       be stored  [default: ./dist]

--help                 Show this message and exit.

Known issues

  • subdirectories of the template are not copied during build (only files in the template root)
  • sass source directory (for third party imports) is not implemented (yet)
  • log output is not nice and colored on Windows (will be fixed in the next release of nxtools)

Legal

Credits

html-template-builder is originally a development by imm studios, z.s. and Aveco inc.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Acknowledgements

This software uses the following third-party open source Python libraries:

  • nxtools released under MIT license
  • htmlmin released under BSD license
  • jsmin released under MIT license
  • jinja2 released under BSD license
  • libsass released under MIT license
  • typer released under MIT license
  • python-watchdog released under Apache Software license