NodeCG is a live graphics system, designed to be used in broadcasts. It is primarily aimed at Twitch broadcasters using Open Broadcaster Software, but is usable in any environment that can render HTML. NodeCG is based on the overlay system developed for the Tip of the Hats 2014 charity event.
| Linux | OS X | Test Coverage |
|---|---|---|
|
|
We currently do not perform automated tests on Windows, as we've yet to develop a good way of running our WebDriver.io tests on it. However, a significant portion of our development is done on Windows and it is safe to assume that if the Linux/OS X builds are passing that the Windows build is OK.
Have questions about NodeCG, or just want to say 'hi'? Join our Gitter!
NodeCG provides a basic bundle system for graphics, as well as a dashboard for controlling the bundles.
A bundle contains HTML, Javascript, CSS, and any other resources required to produce a certain graphic animation and also contains an admin panel for controlling the animation. See nodecg-samples for some examples of how these bundles are structured.
Install node.js & npm.
Then, run the following commands:
git clone https://github.com/nodecg/nodecg.git
cd nodecg
npm install --production
node index.js
To run NodeCG in production, pm2 is recommended.
http://localhost:9090/dashboard to see the admin dashboardhttp://localhost:9090/view/{bundle-name}/Full docs can be found at nodecg.com
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)Before creating your pull request:
npm testCheck which branch you should PR to. NodeCG is still in an unstable state, so we follow these semver guidelines:
0.current.x)0.next.0)NodeCG is provided under the MIT license, which is available to read in the [LICENSE][] file. [license]: LICENSE
FAQs
Dynamic broadcast graphics rendered in a browser
The npm package nodecg receives a total of 3,898 weekly downloads. As such, nodecg popularity was classified as popular.
We found that nodecg demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.
Security News
CISA's KEV data is now on GitHub, offering easier access, API integration, commit history tracking, and automated updates for security teams and researchers.
Security News
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.