NodeCG is a live graphics system, designed to be used during live stream events. It is based on the overlay system used during the Tip of the Hats 2014 event.
NodeCG provides a basic bundle system for graphics, as well as an admin 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 install bower, then run the following:
git clone https://github.com/nodecg/nodecg.git
cd nodecg
npm install
node server.js
Alternatively, if you have forever installed you may run run_nodecg.sh
- Open
http://localhost:9090/dashboardto see the admin dashboard - For each bundle you install, you can see its graphic at
http://localhost:9090/view/{bundle-name}/ - You can configure NodeCG by creating a config.json file.
- Each bundle has its own folder in /bundles/
- Each bundle should be its own git repository
- A nodecg.json file is required in the root directory of your bundle
- You may make an index.js file in the root of your bundle to extend NodeCG.
- A bundle may have multiple panels and multiple views, though most will only have one of each
- Fork it ( https://github.com/nodecg/nodecg/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
NodeCG is provided under the MIT license, which is available to read in the [LICENSE][] file. [license]: LICENSE
Alex "Lange" Van Camp, lead programmer & designer of toth-overlay, contributor to NodeCG
Matt "Bluee" McNamara, contributor to NodeCG
Atmo, original dashboard concept and code