Installation

Prerequisites

Before you can begin using STUK's NodeCG package, you will need to install Node.js (https://nodejs.org/). Node.js® is a free, open-source, cross-platform JavaScript runtime environment. This is what runs NodeCG. Keep all installation options at default, though feel free to change the installation location.

Whilst not necessary, it is also recommended to install Visual Studio Code (https://code.visualstudio.com/), a code editor. It's much cleaner than using something like Notepad, and most importantly, it recognises the programming language of each file, so it will point out errors and suggestions.

Node.js

Visual Studio Code

Installation & Starting

Unzip the STUK-NodeCG folder to the desired location on your computer. You'll then need to edit your Configuration Files before trying to launch NodeCG. Trying to launch without editing any Configuration Files will cause the launch to fail.

Once you've edited the Configuration Files, return to the STUK-NodeCG folder and launch Start NodeCG.bat. This will launch a command window. It does take a few moments to start, but you'll know if it's loaded successfully if the console reports that extensions, webhooks and integrations have been staged or activated. Upon launching, the package will attempt to automatically connect to the Stream Portable OBS - you'll receive an error stating that connection to the OBS Websocket has failed, but the package will still launch and can be used without it.

You'll know if an error has caused the package to fail completely if you're presented with an option to enter a command again.

Once the Config Files have been setup and NodeCG has launched successfully, open any web browser and navigate to your instance's base URL - this will have been set in the Config Files and by default is "localhost:9092". NodeCG's Dashboard will load, though you'll be asked to login first if a login method has been set.

Warnings and errors showing that the OBS Websocket could not be connected, however information messages show that other bundles in the package have loaded and are ready to use

Closing & Saving

When you're ready to close the package, or you need to restart it, return to the Command Prompt window and press 'Ctrl+C'. This cancels the current operation and returns you to the initial command line. You can also just close the window and NodeCG will shut down. There's no save function when closing, all settings or progress designed to be retained between sessions is saved automatically.

If you need to restart NodeCG at any point, cancel the current operation - it'll ask if you want to end the batch job, type 'y'. When it returns you to the initial command line, either close the window and reload it, or just type the instruction 'nodecg start' and press enter to restart it.

Page updated

Google Sites

Report abuse