sos-overlays-2

Second iteration of the broadcast overlays for Swim or Sink, a Splatoon tournament from Inkling Performance Labs.

Use of these graphics are protected via copyright. Do not reuse or redistribute this graphics package, even after modification. See the license here. This repo serves as a reference and to help you make your own graphics from scratch.

Install

1. Follow the instruction here in ipl-overlay-controls to do the initial setup of NodeCG and Overlay Control Panel. This overlay requires version 4.1.0 or higher.

2. Install the sos-overlays-2 bundle into nodecg/bundles using git clone https://github.com/IPLSplatoon/sos-overlays-2.git.

3. Install npm dependencies in the newly created sos-overlays-2 directory using npm install

4. Start nodecg using the nodecg start command in the nodecg folder.

5. Access the dashboard from http://localhost:9090/ in your browser.

6. Access the graphics from the "Graphics" tab in the dashboard. Add the overlays to your streaming application of choice using a browser source. Use a chromium based browser to access graphics (Chrome, Edge, Opera).

Usage

Start NodeCG. By default, the dashboard can be accessed from localhost:9090 in your browser.

From the dashboard, URLs to the graphics can be found from the graphics tab. To use them, they should be added as browser sources in a broadcast application such as OBS Studio. The graphics should be used at a resolution of 1920x1080 and open in a chromium based browser.

Editing source

To edit the source code, please edit the TypeScript (.ts) files. You can compile them into JavaScript (.js) files using the tsc -build command in the root of the project directory (in the sos-overlays-2 folder). You can also use tsc -watch to auto compile code on each change.

Credits

Code was very inspired by other IPL overlays created by inkfarer