puwp-layouts

This is a NodeCG graphics bundle. It is intended to be used with Speedcontrol, as well as our extra Speedcontrol addon bundles for some extra core functionality.

We used to have separate repositories for each event, but now we will simply update this repository going forward.

Getting Started

1. Install Node.js

Instructions on the Node.js site here: https://nodejs.org/en/

NOTE: At time of this writing, the current LTS version is 14.x and the NodeCG developers recommend sticking with the LTS releases for production.

2. Install NodeCG

Follow the install guide here to install the nodecg-cli package: https://www.nodecg.dev/docs/installing

3. Make a working directory and install NodeCG

Create a fresh directory, and run the NodeCG setup in it:

nodecg setup

4. Install bundles

Install the Speedcontrol bundle, our extra Speedcontrol functionality, and this bundle from GitHub using the following commands:

nodecg install speedcontrol/nodecg-speedcontrol
nodecg install PowerUpWithPride/speedcontrol-layoutswitch
nodecg install PowerUpWithPride/speedcontrol-gdqtracker
nodecg install PowerUpWithPride/puwp-layouts

This will create a bundles subfolder inside your new directory that contains git repositories of these two bundles. You can now make whatever changes and tweaks you like from that location.

5. Generate config files

You can generate default config files for the bundles based on their config schemas:

nodecg defaultconfig nodecg-speedcontrol
nodecg defaultconfig speedcontrol-layoutswitch
nodecg defaultconfig speedcontrol-gdqtracker

This will create a new subdirectory called cfg for the config files. Update the speedcontrol-layoutswitch.json and speedcontrol-gdqtracker.json files with your settings for any extra custom layouts, and donation tracker settings if you're using it.

You can check out the JSON config files from the config files repository for NodeCG and Speedcontrol themselves to see exactly what settings we're using. You should copy the Speedcontrol one at least, because that includes the Twitch integration settings.

6. Run the server locally to test

In the directory where you ran setup initially, run the following:

nodecg start

The server should run on localhost:9090 by default. You can open this location in your web browser and start experimenting.

7. Running in production

To run NodeCG in production, pm2 is recommended.