NodeCGのバンドルについての備忘録

概要

• NodeCG のバンドルとはなにか
• nodecg install で何をやっているのか
• どうやってバンドルを作るのか

について書き残しておきます。
NodeCG の基本的なお話は書きません。いっぱい記事あるからね。

NodeCG のバンドルとはなにか

ざっくりいうと nodecg/bundles/{bundleName} 配下に配置されるコンテンツ。
基本的には下記のような構成でいろいろ入ってくる。

nodecg/bundles/{bundleName}/
    dashboards/
    graphics/
    extensions/
    package.json

nodecg install で何をやっているのか

NodeCG CLI のコマンドの一種である install でバンドルをインストールできる。

やってることは非常に単純で

1. 下記いずれかの引数によりリポジトリをクローン
   • Git リポジトリの URL
   • GitHub のユーザ名とリポジトリ名のペア（ {user}/{repo} の形式）
2. 依存ライブラリのインストール（いわゆる npm install ）

これだけ。
あとはバンドルのディレクトリで実行すると、そのバンドルの依存ライブラリをインストールするらしい。

どうやってバンドルを作るのか

上のコードブロックで書いた構成の nodecg/bundles/{bundleName} 配下を GitHub のリポジトリとして公開するのが一番簡単。
ベストプラクティスとしては、タグを切ってコミットしておくのが良さそう（タグを切ってある場合は最新のタグが優先してクローンされる）。そうすると過去のバージョンもインストールできるようになる。 nodecg-speedcontrol とかが参考になる。