SOS Overlay System

SOS-Plugin aims to provide an easy to use event relay in use for Esports broadcasts, particularily in the Tournament sector. Personal streams are able to use this, but it is not officially supported at this moment.

Want some real life examples? Check out the Codename: COVERT assets: https://gitlab.com/bakkesplugins/sos/codename-covert

BakkesMod SDK Setup

The solution contains $(BAKKESMODSDK) environment variable references for the SDK. Create your own environment variable (use Google) point to the SDK base and the configuration will handle the rest

Example variable configuration:

1. My BakkesMod base installation is located at J:\SteamLibrary\steamapps\common\rocketleague\Binaries\Win32\bakkesmod
2. Point the variable to J:\SteamLibrary\steamapps\common\rocketleague\Binaries\Win32\bakkesmod\bakkesmodsdk

BakkesMod Settings File

1. In the root directory of this repo, there's a file named sos.set. This is the BakkesMod Settings File that must be inserted into the following location to be able to control update frequency and SOS events

• J:\SteamLibrary\steamapps\common\rocketleague\Binaries\Win32\bakkesmod\plugins\settings

2. Open bakkesmod/cfg/plugins.cfg in a text editor. At the bottom on its own line, add plugin load sos

Websocket Server

Address: ws://localhost:49122

Most event names are fairly self explanatory, but it is still recommended to listen to the WebSocket server for a game or two to get a feel for when events are fired The websocket reports the following events in channel:event format:

{
  "sos:version": "string",
  "game:match_created": "string",
  "game:initialized": "string",
  "game:pre_countdown_begin": "string",
  "game:post_countdown_begin": "string",
  "game:update_state": {
    "event": "string",
    "game": {
      "arena": "string",
      "ball": {
        "location": {
          "X": "number",
          "Y": "number",
          "Z": "number"
        },
        "speed": "number",
        "team": "number"
      },
      "hasTarget": "boolean",
      "hasWinner": "boolean",
      "isOT": "boolean",
      "isReplay": "boolean",
      "mvp": {
        "id": "string",
        "name": "string"
      },
      "target": "string",
      "teams": {
        "0": {
          "color_primary": "string",
          "color_secondary": "string",
          "name": "string",
          "score": "number"
        },
        "1": {
          "color_primary": "string",
          "color_secondary": "string",
          "name": "string",
          "score": "number"
        }
      },
      "time_milliseconds": "number",
      "time_seconds": "number",
      "winner": "string"
    },
    "hasGame": "boolean",
    "players": {
      "PLAYER OBJECT": {
        "assists": "number",
        "attacker": "string",
        "boost": "number",
        "cartouches": "number",
        "demos": "number",
        "goals": "number",
        "hasCar": "boolean",
        "id": "string",
        "isBoosting": "boolean",
        "isDead": "boolean",
        "isPowersliding": "boolean",
        "isSonic": "boolean",
        "location": {
          "X": "number",
          "Y": "number",
          "Z": "number",
          "pitch": "number",
          "roll": "number",
          "yaw": "number"
        },
        "name": "string",
        "onGround": "boolean",
        "onWall": "boolean",
        "primaryID": "string",
        "saves": "number",
        "score": "number",
        "shortcut": "number",
        "shots": "number",
        "speed": "number",
        "team": "number",
        "touches": "number"
      }
    }
  },
  "game:ball_hit": {
    "ball": {
      "location": {
        "X": "number",
        "Y": "number",
        "Z": "number"
      },
      "post_hit_speed": "number",
      "pre_hit_speed": "number"
    },
    "player": {
      "id": "string",
      "name": "string"
    }
  },
  "game:statfeed_event": {
    "event_name": "string",
    "main_target": {
      "id": "string",
      "name": "string",
      "team_num": "number"
    },
    "secondary_target": {
      "id": "string",
      "name": "string",
      "team_num": "number"
    },
    "type": "string"
  },
  "game:goal_scored": {
    "ball_last_touch": {
      "player": "string",
      "speed": "number"
    },
    "goalspeed": "number",
    "impact_location": {
      "X": "number",
      "Y": "number"
    },
    "scorer": {
      "id": "string",
      "name": "string",
      "teamnum": "number"
    }
  },
  "game:replay_start": "string",
  "game:replay_will_end": "string",
  "game:replay_end": "string",
  "game:match_ended": {
    "winner_team_num": "number"
  },
  "game:podium_start": "string",
  "game:podium_end": "string",
  "game:match_destroyed": "string"
}

Libraries Required

The following libraries can be retrieved from this submodule: https://gitlab.com/bakkesplugins/sos/sos-plugin-includes