README.md

skate's Bundles

This repository contains NodeCG bundles, that are used in twitch livestreams. This includes live chat interacation and remote control capabilities, e.g., triggering smart lights by channel points. All bundles rely on the nodecg-io project.

Bundle Overview

• nanoleaf-events triggers Nanoleaf Shapes based on live events like channel points, subs, and hype trains
• stream-bar shows stream meta information like current song playing and last sub in a bar visible in the stream
• stream-info provides a chat bot and a stream overlay, answering what the streamer currently does and commonly asked questions
• skates-utils provides common functionality used by the other bundles

Installation

1. Make sure that you have NodeCG and nodecg-io development version 0.3 already installed.

2. Clone this repo into the nodecg-io installation directory

   nodecg/nodecg-io $ git clone https://github.com/sebinside/skates-bundles.git

3. Add skates-bundles to the workspace configuration

   Open the package.json and add skates-bundles/* to the workspaces array.

   Your package.json with the added entry might look like this (don't copy this, make the change yourself! The package.json might change in the nodecg-io repo.):

   File: nodecg/nodecg-io/package.json

   ...
   ~    "workspaces": [
   ~        "nodecg-io-core",
   ~        "nodecg-io-core/dashboard",
   ~        "services/*",
   ~        "samples/*",
   -        "utils/*"
   +        "utils/*",
   +        "skates-bundles/*"
   ~    ]
   ~ }

4. Add skates-bundles to the NodeCG configuration

   Add the absolute path to the skates-bundles directory to the NodeCG configuration file that is located at path/to/nodecg/cfg/nodecg.json.

   Your nodecg.json might look like this with nodecg-io, the nodecg-io samples and skates-bundles installed:

   File: /nodecg/cfg/nodecg.json

   ~ {
   ~     "bundles": {
   ~         "paths": [
   ~             "/absolute/path/to/nodecg/nodecg-io",
   ~             "/absolute/path/to/nodecg/nodecg-io/services",
   -             "/absolute/path/to/nodecg/nodecg-io/samples"
   +             "/absolute/path/to/nodecg/nodecg-io/samples",
   +             "/absolute/path/to/nodecg/nodecg-io/skates-bundles"
   ~         ]
   ~     }
   ~ }

5. Install and compile

   Install all dependencies of all bundles in this repository, link all nodecg-io components and compile TypeScript using these commands:

   nodecg/nodecg-io $ npm install
   nodecg/nodecg-io $ npm run build

   Note that this is run in the nodecg-io directory and not in the skates-bundles directory.

6. Start NodeCG

   It should display all nodecg-io related bundles and all bundles that are in the skates-samples repository. If not, make sure that you got your configuration files from step 3 through 5 right.

Bundle-specific Requirements and Usage

For bundle-specific requirements, custom installation hints, and notes on the usage, please refer to the bundle folders' README files.