Skip to content
Create broadcast graphics using Node.js and a browser
JavaScript HTML Other
Branch: master
Clone or download

Latest commit

zoton2 fix(types): add/tweak types for replicant/readReplicant (#545)
* Add typing for replicant persistence interval

* Move typings for readReplicant to NodeCGCommon interface

* Add overridden typings for readReplicant on server
Latest commit 73dd2cc Mar 13, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build/src style: fixup last merge conflicts Mar 9, 2020
bundles Seriously, how do I .gitignore Sep 11, 2014
db Seriously, how do I .gitignore Sep 11, 2014
lib style: fixup last merge conflicts Mar 9, 2020
media docs(media): update splash Jul 19, 2018
schemas feat(dashboard): implement redesigned graphics tab with refresh butto… Jul 19, 2018
src style: use Prettier for code style enforcement (#541) Mar 9, 2020
test style: fixup last merge conflicts Mar 9, 2020
types fix(types): add/tweak types for replicant/readReplicant (#545) Mar 13, 2020
typetest/fake-bundle style: use Prettier for code style enforcement (#541) Mar 9, 2020
.dockerignore feat(docker): update Dockerfile (#528) Mar 9, 2020
.editorconfig docs: add minimal documentation for workspaces and fullbleed panels May 23, 2017
.eslintignore style: use Prettier for code style enforcement (#541) Mar 9, 2020
.eslintrc style: use Prettier for code style enforcement (#541) Mar 9, 2020
.gitattributes style: use Prettier for code style enforcement (#541) Mar 9, 2020
.gitignore chore: remove/ignore JetBrains and VS Code IDE files (#522) Sep 10, 2019
.prettierignore style: use Prettier for code style enforcement (#541) Mar 9, 2020
.prettierrc.js style: use Prettier for code style enforcement (#541) Mar 9, 2020
.travis.yml build: remove docs build job Mar 9, 2020
AUTHORS add matt's homepage url to AUTHORS Jan 28, 2015
CHANGELOG.md style: use Prettier for code style enforcement (#541) Mar 9, 2020
CODE_OF_CONDUCT.md style: use Prettier for code style enforcement (#541) Mar 9, 2020
CONTRIBUTING.md style: use Prettier for code style enforcement (#541) Mar 9, 2020
Dockerfile feat(docker): update Dockerfile (#528) Mar 9, 2020
LICENSE docs(LICENSE): bump year Feb 13, 2018
README.md docs: update readme Mar 3, 2020
ava.config.js style: use Prettier for code style enforcement (#541) Mar 9, 2020
gulpfile.js style: use Prettier for code style enforcement (#541) Mar 9, 2020
index.js fix: only exit with code 0 on server stop if there isn't already an e… Mar 9, 2020
package-lock.json style: use Prettier for code style enforcement (#541) Mar 9, 2020
package.json style: use Prettier for code style enforcement (#541) Mar 9, 2020
tsconfig.json style: use Prettier for code style enforcement (#541) Mar 9, 2020

README.md

NodeCG

NodeCG

Discord Build Status Coverage Status Docker Build Status Twitter

NodeCG is a broadcast graphics framework and application. It enables you to write complex, dynamic broadcast graphics using the web platform. NodeCG has no graphics or drawing primitives of its own. Instead, NodeCG provides a structure for your code and an API to facilitate moving data between the dashboard, the server, and your graphics. It makes no assumptions about how to best code a graphic, and gives you complete freedom to use whatever libraries, frameworks, tools, and methodologies you want. As such, NodeCG graphics can be rendered in any environment that can render HTML, including:

Don't see your preferred streaming software on this list? NodeCG graphics require Chrome 49 or newer. If your streaming software's implementation of browser source uses a build of CEF that is based on at least Chrome 49, chances are that NodeCG graphics will work in it. You can check what version of Chrome your streaming software uses for its browser sources by opening whatversion.net/chrome as a browser source.

Have questions about NodeCG, or just want to say 'hi'? Join our Discord server!

Documentation & API Reference

Full docs and API reference are available at https://nodecg.com

Goals

The NodeCG project exists to accomplish the following goals:

  • Make broadcast graphics (also known as "character generation" or "CG") more accessible.
  • Remain as close to the web platform as possible.
  • Support broadcasts of any size and ambition.

Let's unpack what these statements mean:

> Make broadcast graphics (also known as "character generation" or "CG") more accessible

Historically, broadcast graphics have been expensive. They either required expensive hardware, expensive software, or both. NodeCG was originally created to provide real-time broadcast graphics for Tip of the Hats, which is an all-volunteer charity fundraiser that had a budget of $0 for its first several years.

Now, it is possible to create an ambitious broadcast using entirely free software and consumer hardware. The NodeCG project embraces this democratization of broadcast technology.

> Remain as close to the web platform as possible

NodeCG graphics are just webpages. There is absolutely nothing special or unique about them. This is their greatest strength.

By building on the web platform, and not building too many abstractions on top of it, people developing broadcast graphics with NodeCG have access to the raw potential of the web. New APIs and capabilities are continually being added to the web platform, and NodeCG developers should have access to the entirety of what the web can offer.

> Support broadcasts of any size and ambition

NodeCG's roots are in small broadcasts with no budget. More recently, NodeCG has begun seeing use in increasingly elaborate productions. We believe that one set of tools can and should be able to scale up from the smallest show all the way to the biggest fathomable show. Whether you're using OBS for everything, or a hardware switcher with a traditional key/fill workflow, NodeCG can be a part of any broadcast graphics system.

Maintainers

Designers

Acknowledgements

You can’t perform that action at this time.