Code Monkey home page Code Monkey logo

casparcg_html_widget's Introduction

CasparCG HTML Template Developer Widget

The CasparCG Widget is a drop in script that creates a small on screen widget which will interact with your HTML Templates. It is written in TypeScript and the converted JS file is called dev.js and can be found in the dist folder.

Join the discussion on the CasparCG Forum.

Features

Change the background color quickly using a color keyword, HEX, RGB or, RGBA values without editing the CSS file.
Set the background to an image using a URL.
Run custom commands (Invoke Command) from the widget.
Easily run the standard Update, Play, Next, and Stop Commands.
Set custom data with a convenient GUI that is injected into the graphic template's update function.
Save multiple data sets for templates that require more than the initial update data.
All data is persistent between page reloads!

Live Demo

Try the live demo here!

Setup

You can load the dev.js file directly in your HTML by adding the following line.

<script rel="application/javascript" src="http://yourwebserver/dev.js"></script>

Then visit the template's URL with ?debug=true as the query string.

Example: http://localhost:3000/html/template.html?debug=true

Development Setup

To develop the widget itself, you will need NPM installed and then to follow these two additional steps.

  1. Run npm install in a command prompt in the root folder of this repo.
  2. Run npm run-script start to launch the WebPack Dev Server.

The development server should now be live at http://localhost:3000.

Widget API

The widget offers a full API for interacting with the widget itself.
For the full list, type _widget.help into the console.

Some Images of the Widget for Reference

Dev Tool Open Dev Tool Shrunk Dev Tool Hidden Dev Tool Update Data

A Few Extra Details

This was built for CasparCG version 2.2.0 Stable.
The Chromium version for CasparCG is 63.0.3239.132 and the widget was built in version 63.0.3239.0 which can be found here.
Find Chromium download by version here. The Branch Base Position is the folder on this page.

Please reach out with additions, suggestions, improvements or really anything!

casparcg_html_widget's People

Contributors

chrisryanouellette avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.