StartGG - Ateozc/RoA-Stream-Tool GitHub Wiki

StartGG integration was a planned feature ages ago for me. This is going to be a fun one.

What can it do?

The startGG integration is capable of doing the following:

  • Grab all participants for an event
  • Populate current in progress match for a player into the stream tool
  • Populate the player information for set based upon the following
    • Can use the Player Profiles stored in the Stream Tool
    • Can use the data from the StartGG profile
    • Can prioritize using data from one, and fill data into empty fields from the other.
      • Example: Player has Pronouns in StartGG but not on the Stream Tool, you can choose to use the StartGG pronouns instead of having that blank. The reverse is also true.
  • Get the Round Name from the Set in StartGG
  • Get the Tournament Name
  • Get the Game (used in the MultiGame select plugin)
  • Push the current set information to StartGG
  • Populate Top 8 Bracket in Stream Tool from StartGG

Notes:

  • When populating the match information into the Stream Tool, it does set the Player information. However, it DOES NOT save that information into the player profiles on the Stream Tool. If you want to save that, you will have click into the player profile and click "Save and Apply". This was done to prevent large amounts of excess data being saved on your computer.

How to set up

There are a few things that need to be done. The first step is to get yourself an authentication token from StartGG. This will be used to connect with StartGG. If you dont have one, please follow the instructions here: https://developer.start.gg/docs/authentication

Once you have the token, you will need to navigate to the Stream Tool folder and navigate to /Resources/Texts/startGGAuth.json Open the startGGAuth.json file (I recommend notepad++ or VS Code) Where it says "key":"" you will want to put your auth token into the empty parenthesis. Example: "key":"yourKeyGoesHere" After that has been changed, save the file.

Time to verify it works. Open up the Stream Tool and open the Settings panel. Look for the StartGG section. Enter the URL or Event ID of an event. As an example, you can use https://www.start.gg/tournament/riptide-2023-4/event/rivals-of-aether-singles

After entering the URL/Event ID, click the "Get Event Information". Once it has found the event it will give you more options to work with.

How to use it

Once you have established a connection with StartGG, itll grab the event information to be used with the Stream Tool. You will gain the following buttons:

Populate Tournament Name

  • This button will populate the tournament name into the Tournament Name field on the Stream Tool. It will overwrite what you currently have.

Populate Game from Event

  • This button will change the currently selected game on the Stream Tool to the one that was in StartGG (if it exists).

Populate top 8 bracket

  • Populates the Top 8 Bracket that is built into the Stream Tool. This allows for easier access to the Top 8 information when streaming. No more populating this yourself. (Currently does not pull the character information as that is not provided for some reason).

Select a player

  • Used to when clicking the "Populate current match info from Player". This is the player it looks at when populating the information.

Prioritize StartGG Data

  • When selected, the Player profile information will be populated based upon StartGG data. (Player GamerTag, Sponsor, Pronouns, and Socials).

Prioritize Non Empty Values

  • When selected, the Player profile information will be populated first by Profile data within the Stream Tool (unless the above checkmark is used). After that, any fields that do not have a value will be backfilled from the other profile.
    • Example: A player has pronouns in StartGG but none in the Stream Tool. The player has no socials on StartGG and all the socials on the Stream Tool.
    • This would allow you to combine them into a single Profile with all the information.
  • If not checked, it will only use one profile or the other.

Populate Round Name

  • When populating the match information it will also populate the Round Name from StartGG.

Populate current match info from Player

  • Populates the current match information for the selected player based upon the selections above. The match will only be found if the selected player is currently in a match. The match in StartGG must be in "Match Started" state.
  • Fields that this utilizes:
    • Prioritize StartGG Data
    • Prioritize Non Empty Values
    • Populate Round Name

Update StartGG Set

  • Updates the StartGG set with the current match information. *Requires you to populate the match information first.