nsg2-layouts

Broadcast graphics for speedrun marathon events from the Norway Speedrunner Gathering, informally known as "Norskontrol" or "inkontrol".

Preamble

I've published the source code for these graphics so others may learn from them as I learned from nodecg-speedcontrol and agdq19-layouts while writing these graphics. With that in mind, please do not use these graphics as-is and use them as a reference to learn or as a base for a new project. The use of Norway Speedrunner Gathering's logos or other image assets is forbidden without prior permission.

~ inkfarer, project developer

Setup

• Clone this repository to [nodecg]/bundles/nsg2-layouts
• Install dependencies: npm i
• Run build: npm run build

Configuration

To configure this bundle, create the file [nodecg]/cfg/nsg2-layouts.json with the following contents:

{
  "intermission": {
    "addVisualizerSpace": true,
    "addCameraSpace": true
  },
  "obs": {
    "sceneDataInTransitionEvents": false
  },
  "event": {
    "timezone": "Europe/Oslo",
    "name": "NSG Fall 2024",
    "donationUrl": "donate.nsgmarathon.com",
    "currency": {
      "code": "NOK",
      "unit": " kr"
    }
  },
  "oengus": {
    "useSandbox": false
  },
  "tracker": {
    "address": "tracker.example.org",
    "socketAddress": "wss://tracker.example.org/tracker/ws/donations/",
    "username": "example-user",
    "password": "example-pwd",
    "eventId": 2
  },
  "twitch": {
    "clientId": "twitch_client_id",
    "clientSecret": "twitch_client_secret",
    "redirectUri": "http://localhost:9090/nsg2-layouts/twitch-auth",
    "titleTemplates": {
      "speedrun": "NSG Fall 2024: {{title}} [{{category}}] by {{talent}}",
      "race": "NSG Fall 2024: {{title}} [{{category}}] - {{talent}}",
      "other": "NSG Fall 2024: {{title}} with {{talent}}",
      "withoutTalent": "NSG Fall 2024: {{title}}",
      "fallback": "NSG Fall 2024 benefiting Norges Blindeforbund"
    }
  },
  "foobar2000": {
    "address": "http://localhost:8880",
    "username": "fb2k-user",
    "password": "fb2k-pwd"
  },
  "x32": {
    "address": "192.168.1.102",
    "transitionFps": 30,
    "defaultSpeakingDBThreshold": -75,
    "disableNameplateVolumeMeters": false,
    "transitionDurations": {
        "mute": 500,
        "unmute": 750
    },
    "channelMapping": {
      "runners": [{ "type": "DCA", "number": 1 }],
      "games": [{ "type": "DCA", "number": 2 }]
    }
  }
}

Time zones

Find a list of time zones here.

Music

Music information is gathered through foobar2000 with the beefweb plugin installed.

X32 integration

When configuring mixer channel mappings (x32.channelMappings), the following channel types are accepted: CHANNEL, AUX_IN, FX_RETURN, BUS, MATRIX & DCA

OBS Websocket

nsg2-layouts can be used in conjunction with a modified build of obs-websocket to react to scene changes when a transition starts as opposed to when it completes. If this build is in use, set the obs.sceneDataInTransitionEvents property in the bundle configuration file to true. Otherwise, set it to false.

Visualizer & Camera spaces

Set intermission.addVisualizerSpace to true in the configuration file to add an empty space to the intermission graphic, intended for an audio visualizer. This hasn't been used in any live NSG events.

Set intermission.addCameraSpace to false in the configuration file to remove the cutout intended for a camera feed from the intermission graphic, useful for online events.

Usage

Game layout

Opening the game layout graphic with the is-layout-leader query parameter allows it to take charge of positioning camera sources in OBS. This allows multiple game layout graphics to be open without them potentially interfering with one another.
Example: http://localhost:9090/bundles/nsg2-layouts/graphics/game-layout.html?is-layout-leader

Scene name rules

The following suffixes may be added to the end of OBS scene names to modify the stream while those scenes are in the program feed.

• [M]: Play music
• [G]: Unmute game audio
• [R]: Unmute runners

These suffixes may be combined. For example, a scene named Test Scene [MG] will play music and unmute the game audio while it is in the program feed.

Oengus login

Logging in to Oengus is possible using the Data Import dashboard panel. All Oengus functionality is present without doing so, but schedules will be imported without any cache on Oengus' side if the logged-in user is a moderator of the marathon being imported. This means that updates to the schedule will appear without any delay.

npm commands

• build: Create a production-ready build.
• build:dev: Create a development build with better debugging options.
• build:clean: Combines build and clean tasks.
• clean: Removes built files.
• start: Starts NodeCG.
• watch: Runs a build and rebuilds when changes are found.
• schema-types: Create or update type definitions for replicant schemas found in the schemas directory
• test: Run project tests. As of writing, tests are only written for a limited set of more complicated logic in the application.

License & Acknowledgements

• The source code for the nsg2-layouts project is licensed under the MIT license
• Norges Blindeforbund's logo may only be used with their prior permission. View more information here (in Norwegian)
• Any other image assets in this repository may only be used with prior permission from the Norway Speedrunner Gathering
• The DSEG font family by keshikan is licensed under the SIL Open Font License, version 1.1
• The HD44780A00 5x8 by Lord Nightmare on FontStruct is licensed under the Creative Commons BY-SA 3.0 License
• The list of country and region flags in this project's flags directory is from the region-flags project by fonttools.