Configuration Information - SSBDoppler/slippi-hud GitHub Wiki

Overview

Now thanks to the new and improved configschema.json, we generate a proper cfg file by running nodecg defaultconfig slippi-hud But you may be wondering what it does and this page is here to answer some questions. I've touched a little bit on it in the OBS page but I'm going to cover the whole thing here as well.

Startgg API

"api": { "startgg": { "key": "API TOKEN HERE" } },

where you put the api token you get from the start.gg page

Templates

"hudTemplatePath": "elements/templates" tells SlippiHUD where to look for the default templates in the template selector dashboard window.

Stats

"slpDumpPath": { "inBundle": true, "path": "slpDumps" }

Because of stats, we decided to create our own slp files for slippiHUD stat calculations. inBundle sets whether the slps will be store in slippi-hud bundle or if false you can set a folder anywhere on your computer. This is set to true by default.

path sets where the slps will be stored. default is set to slpDumps which is a folder in the slippi-hud bundle

"extraStats": [ "ipm", "dpo", "lc", "fb", "ek", "ld", "sd", "hdp" ] is also all the non-standard stats that you can call with the Stats graphics. My stats graphic is just a rebase of Slippi Stats by Vince AU to work in nodecg instead of as a stand alone react application. His is way easier to customize and already looks amazing, but I wanted it slippiHUD to be a one stop shop for your streaming needs.

OBS

"obs": {
    "scenes": {
      "Handwarmer": {
        "autoSwitch": true,
        "delay": 0
      },
      "Tournament": {
        "autoSwitch": true,
        "delay": 0
      },
      "Game End": {
        "autoSwitch": true,
        "delay": 1
      },
      "Set End": {
        "autoSwitch": true,
        "delay": 1
      },
      "Wait": {
        "autoSwitch": true,
        "delay": 0
      }
    }
  }

these are the default settings. delay is how many seconds it takes from when conditions are met to switching to the correct scene. autoswitch false will result in OBS not auto-switching to that scene when it otherwise would have.

Automate scoring toggle

			"type": "boolean",
			"default": false
		}

By default is set to false.

When set to true, SlippiHUD will automatically set itself to handwarmer mode after a set ends.

Additionally, SlippiHUD will allow one game to be played in handwarmer mode before auto switching to tournament mode after that game concludes.

This feature was not as helpful as intended, players are fickle beasts.