sj-overlays

Broadcast overlays for SuperJump, a Splatoon tournament by Inkling Performance Labs.

Setup

• Set up ipl-overlay-controls using the installation guide.
• To properly see blur effects in older versions of OBS (before 27.2), add --enable-experimental-web-platform-features to your OBS launch parameters. On Windows, create a new shortcut to the OBS executable and add the parameter to the "Target" field of the shortcut: Image example
• To properly see blur effects in older versions of Chrome (Particularly ones not supporting backdrop-filter), enable "Experimental Web Platform features" in chrome://flags/
• To get detailed team data from IPL Central, some configuration must be provided. To do so, create the file [nodecg]/cfg/sj-overlays.json with the following contents:

  {
      "central": {
    	  "basePath": "Base path to IPL Central. e.g. http://localhost:2000",
          "frontendPath": "Path to IPL Central's frontend. e.g. http://localhost:3000"
      }
  }

Pre-built version (For production use)

• Clone the build branch of this repository to [nodecg]/bundles/sj-overlays
• All done!

Build manually

• Ensure you have access to the private GSAP registry ('Shockingly' tier at minimum): Guide
• Clone this repository to [nodecg]/bundles/sj-overlays
• Install dependencies: npm i
• Run build: npm run build

Other npm commands

• build: Create a production-ready build.
• devbuild: Create a development build with better debugging options.
• clean: Removes built files.
• cleanbuild: Combines build and clean tasks.
• start: Starts NodeCG.
• watch: Runs a build and rebuilds when changes are found.
• lint: Checks for linter errors
• fix: Automatically fixes some linter errors

Container Images

We've included Docker Container image builds with this repository. To use the Docker image you can create a Docker Compose file like the following:

services:
  sj-overlays:
    image: 'ghcr.io/iplsplatoon/sj-overlays:master'
    ports:
      - '9090:9090'
    volumes:
      - '[absolute path to logs dir on host filesystem]:/opt/nodecg/logs'
      - '[absolute path to db dir on host filesystem]:/opt/nodecg/db'
      - '[absolute path to assets dir on host filesystem]:/opt/nodecg/assets'
      - '[absolute path to cfg dir on host filesystem]:/opt/nodecg/cfg'

For more information please refer to the NodeCG Docker Documentation