Yeoman generator for NodeCG bundles
Clone or download
TreZc0 and Hoishin feat: Added clarification on Width units (#63)
* Added clarification on Width units

This should be sufficient to allow users to get an idea of the width units.
A note could be added that these settings can easily be adjusted in the package.json afterwards.

* Updated Equation for Dashboard Panel Width

Better description
Latest commit 56056f4 Oct 13, 2018


NPM version Build Status Test Coverage

Yeoman generator for NodeCG bundles

generator-nodecg can be used to quickly start a new bundle with the barebones boilerplate files that every bundle needs. It can also be used to add a new panel, graphic, or extension in an existing bundle.


First, install Yeoman and generator-nodecg using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-nodecg

Then generate your new bundle:

yo nodecg

generator-nodecg also has specific sub-generators that can be used on existing bundles:

yo nodecg:panel
yo nodecg:graphic
yo nodecg:extension

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to learn more about him.

Special Thanks

Significant portions of this generator are based on generator-node. We thank the developers of generator-node and Yeoman for their years of hard work.


MIT © Alex Van Camp