lolsteve / nodecg

A live graphics system using node.js

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	Windows	Test Coverage

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.

Installation

First, install node.js & npm.
Next, you'll need to install Python 2.7 on Windows. Mac OS X and Linux should have this already.
Finally, install Visual Studio Express on Windows, Xcode on OS X, and build-essential (or equivalent) on Linux.
Now 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.

Usage

• Open http://localhost:9090/dashboard to 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 cfg/nodecg.json file.

Full Documentation

Full docs can be found at nodecg.com

Contributing

1. Fork it ( http://github.com/nodecg/nodecg/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Before creating your pull request:

1. Ensure your code matches our existing style using our provided EditorConfig options
2. Ensure the existing tests pass, or are updated appropriately, with npm test
3. For new features, you should add new tests

Check which branch you should PR to. NodeCG is still in an unstable state, so we follow these semver guidelines:

• Bug fixes and new features go to the next 'patch' branch (0.current.x)
• Breaking changes go to the next 'minor' branch (0.next.0)

License

NodeCG is provided under the MIT license, which is available to read in the [LICENSE][] file. [license]: LICENSE

Credits

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