From bde142aacfe3fc424ee40a41121c91bd9d90034c Mon Sep 17 00:00:00 2001 From: Ewan Lyon Date: Wed, 10 Feb 2021 13:40:47 +1100 Subject: [PATCH] Add data types and explanations --- docs/Messages.md | 11 +- docs/Replicants.md | 420 ++++++++++++++++++++++++++++++++++----------- 2 files changed, 326 insertions(+), 105 deletions(-) diff --git a/docs/Messages.md b/docs/Messages.md index 1a5b0af..5817c48 100644 --- a/docs/Messages.md +++ b/docs/Messages.md @@ -1,3 +1,8 @@ +Messages +======== + + + # API Documentation: Messages _[Link to NodeCG documentation for reference.](https://www.nodecg.dev/docs/classes/listenFor)_ @@ -30,6 +35,7 @@ nodecg.listenFor('message-name', 'nodecg-csgo-manager', (data) => { ## newPhase When the round is in a new phase this will transmit the output as `newPhase:` + the phase name. + _No data is sent with this message_ ### Possible messages @@ -47,6 +53,7 @@ _No data is sent with this message_ ## newBomb When the bomb is in a new state this will transmit the output as `newBomb:` + the state name. + _No data is sent with this message_ ### Possible messages @@ -125,7 +132,7 @@ Message sent everytime a player is killed. Used for killfeeds. ## hlae:weaponFire -Used to show weapon fire on the mini map. Remember to not show if the weapon is a knife. +Used to show weapon fire on the mini map. Remember to not show if the weapon is a knife or grenade. ```JSON { @@ -143,4 +150,4 @@ Used to show weapon fire on the mini map. Remember to not show if the weapon is }, "round": 2 } -``` +``` \ No newline at end of file diff --git a/docs/Replicants.md b/docs/Replicants.md index 847981b..fb997b6 100644 --- a/docs/Replicants.md +++ b/docs/Replicants.md @@ -2,6 +2,8 @@ _[Link to NodeCG documentation for reference.](https://www.nodecg.dev/docs/classes/replicant)_ +[Usage](#usage) + CSGO Data - [game](#game) @@ -12,8 +14,7 @@ CSGO Data - [phase](#phase) - [mapGrenades](#mapGrenades) - [mapPlayers](#mapPlayers) -- [teamOne](#teamOne) -- [teamTwo](#teamTwo) +- [teamOne / teamTwo](#teamOne) - [round30Winner](#round30Winner) - [playerData](#playerData) @@ -66,7 +67,9 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `object`: CSGO +- `object` + +Each property inside the game object is detailed in replicants below ### Example data @@ -80,7 +83,24 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `object`: Map +- `object` + - `mode` [string] Type of match the game is. Most likely "competitive". + - `name` [string] Map name + - `phase` [string] Phase the match is in + - `round` [number] Current round + - `team_ct` [object] Counter Terrorists + - `score` [number] Team score + - `consecutive_round_losses` [number] Amount of rounds lost in a row. Used for loss bonus + - `timeouts_remaining` [number] Amount of timeouts the team has remaining + - `matches_won_this_series` [number] Matches won for this series + - `team_ct` [object] Terrorists + - Same as `team_ct` + - `num_matches_to_win_series` [number] Matches need to win. Would dictate Bo3 or Bo5, etc. + - `current_spectators` [number] Number of people spectating the game + - `souvenirs_total` [number] Souvenirs given out in the current match + - `round_wins` [key value pair] + - `key` [string] of round number + - `value` How the round was won ("ct_win_defuse", "ct_win_time", "ct_win_elimination", "t_win_elimination", "t_win_bomb") ### Example data @@ -90,12 +110,27 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ "name": "de_dust2", "phase": "live", "round": 4, - "team_ct": { "score": 0, "consecutive_round_losses": 5, "timeouts_remaining": 1, "matches_won_this_series": 0 }, - "team_t": { "score": 4, "consecutive_round_losses": 0, "timeouts_remaining": 1, "matches_won_this_series": 0 }, + "team_ct": { + "score": 0, + "consecutive_round_losses": 5, + "timeouts_remaining": 1, + "matches_won_this_series": 0 + }, + "team_t": { + "score": 4, + "consecutive_round_losses": 0, + "timeouts_remaining": 1, + "matches_won_this_series": 0 + }, "num_matches_to_win_series": 0, "current_spectators": 0, "souvenirs_total": 0, - "round_wins": { "1": "t_win_bomb", "2": "t_win_bomb", "3": "t_win_elimination", "4": "t_win_elimination" } + "round_wins": { + "1": "t_win_bomb", + "2": "t_win_bomb", + "3": "t_win_elimination", + "4": "t_win_elimination" + } } ``` @@ -103,11 +138,48 @@ The map property of the raw CSGO Game State Integration. ## allPlayers +Array of all players from the `allplayers` property. Made into an array with a new steamId property and if observer slot is 0 it is changed to 10. + _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `[object]`: CSGOAllplayer[] +- `array` + - `object` + - `steamid` [string] Steam ID of the player + - `name` [string] Name of the player + - `observer_slot` [number] 0-9 of the observer ID + - `team` [string] Which side the player is on ("T" or "CT") + - `activity` [string] What the player is currently doing + - `position`[string] X, Y and Z location of player + - `rotation`[string] X, Y and Z rotation of player + - `match_stats` [object] Information about the player's total match statistics + - `kills` [number] Number of kills + - `assists` [number] Number of assists + - `deaths` [number] Number of deaths + - `mvps` [number] Number of MVPs + - `score` [number] Total score + - `weapons` [object] Dictionary of weapons the player has + - `string` Key ID of weapon ("weapon_0", "weapon_1") + - `name` [string] Name of weapon + - `paintkit` [string] Weapon skin + - `type` [string] Type of weapon, ("C4", "Grenade", "Knife", "Pistol", "Rifle", "SniperRifle", "Shotgun", "Submachine Gun", "Machine gun") + - `state` [string] If weapon is being held or not ("active", "holstered") + - `ammo_clip` Amount of ammo currently in the gun + - `ammo_clip_max` Amount of ammo the gun can have per clip + - `ammo_reserve` Amount of ammo the player has left + - `state` Player game data + - `health` [number] Player's health + - `armor` [number] Amount of armour left + - `helmet` [boolean] If armour has a helmet + - `flashed` [number] If player is flashed. (Unknown if 0-1 or a percentage) + - `smoked` [number] If player is in smoke. (Unknown if 0-1 or a percentage) + - `burning` [number] If a player is burning. (Unknown if 0-1 or a percentage) + - `money` [number] Amount of money the player has + - `round_kills` [number] Number of kills this round + - `round_killhs` [number] Number of kill this round that have been headshots + - `round_totaldmg` [number] Total damage done this round + - `equip_value` [number] Value of equipment ### Example data @@ -130,9 +202,20 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ "round_totaldmg": 0, "equip_value": 3400 }, - "match_stats": { "kills": 1, "assists": 1, "deaths": 4, "mvps": 0, "score": 3 }, + "match_stats": { + "kills": 1, + "assists": 1, + "deaths": 4, + "mvps": 0, + "score": 3 + }, "weapons": { - "weapon_0": { "name": "weapon_knife", "paintkit": "default", "type": "Knife", "state": "holstered" }, + "weapon_0": { + "name": "weapon_knife", + "paintkit": "default", + "type": "Knife", + "state": "holstered" + }, "weapon_1": { "name": "weapon_deagle", "paintkit": "default", @@ -145,7 +228,7 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ "weapon_2": { "name": "weapon_ssg08", "paintkit": "default", - "type": "SniperRifle", + "type": "SniperRifle", "ammo_clip": 10, "ammo_clip_max": 10, "ammo_reserve": 90, @@ -158,15 +241,32 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ] ``` -Array of all players from the `allplayers` property. Made into an array with a new steamId property and if observer slot is 0 it is changed to 10. - ## observingPlayer +Data of the observed player + _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `object | undefined`: CSGOPlayer | undefined +- `object | undefined` + - `steamid` [string] Steam ID of the player + - `name` [string] Name of the player + - `observer_slot` [number] 0-9 of the observer ID + - `team` [string] Which side the player is on ("T" or "CT") + - `activity` [string] What the player is currently doing + - `state` Player game data + - `health` [number] Player's health + - `armor` [number] Amount of armour left + - `helmet` [boolean] If armour has a helmet + - `flashed` [number] If player is flashed. (Unknown if 0-1 or a percentage) + - `smoked` [number] If player is in smoke. (Unknown if 0-1 or a percentage) + - `burning` [number] If a player is burning. (Unknown if 0-1 or a percentage) + - `money` [number] Amount of money the player has + - `round_kills` [number] Number of kills this round + - `round_killhs` [number] Number of kill this round that have been headshots + - `round_totaldmg` [number] Total damage done this round + - `equip_value` [number] Value of equipment ### Example data @@ -193,15 +293,19 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ } ``` -Data of the abserved player - ## bomb +Status of the bomb, whether it is dropped, being carried or planted. + _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `object`: CSGOBomb +- `object` + - `state` [string] What state the bomb is currently in. ("planted". "exploded", "carried", "planting", "dropped", "defusing", "defused") + - `position` [string] X, Y and Z location of the bomb + - `player` [string] Player currently carrying or defusing the bomb + - `countdown` [string] Bomb countdown ### Example data @@ -213,15 +317,17 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ } ``` -Status of the bomb, whether it is dropped, being carried or planted. - ## phase +What state the game is currently in. + _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `object`: CSGOPhaseCountdowns +- `object` + - `phase` [string] What phase the game is in ("live", "bomb", "over", "freezetime", "paused", "defuse", "timeout_t", "timeout_ct", "warmup") + - `phase_ends_in` [string] How long the phase will last ### Example data @@ -232,22 +338,28 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ } ``` -What state the game is currently in. - ## mapGrenades +List of all grenades that are active. Incendiary and Molotovs are called `firebomb` and each flame is sent as a grenade. + _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `object`: CSGOGrenadesAll +- `object` + - `string` Key of grenade ID (each grenade has a unique ID) + - `owner` [string] Steam ID of player that threw the grenade + - `position` [string] X, Y and Z location of grenade + - `velocity` [string] Speed of grenade? + - `lifetime` [string] How long the grenade has existed + - `type` [string] Type of grenade ### Example data ```JSON { "765": { - "owner": 76561197960265732, + "owner": "76561197960265732", "position": "-220.44, 245.03, -2.44", "velocity": "-583.21, 491.35, -120.78", "lifetime": "1.4", @@ -256,15 +368,23 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ } ``` -List of all grenades that are active. Incendiary and Molotovs are called `firebomb` and each flame is sent as a grenade. - ## mapPlayers +A cleaned object showing only the necessary information needed to place a player on a mini map. **NOT INTERPRETED, Will be stuttery**. + _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ### Data -- `[object]`: MapPlayerData[] +- `array` + - `object` + - `steamId` [string] Player's Steam ID + - `position`[number[3]] X, Y and Z location of player + - `rotation`[number[3]] X, Y and Z rotation of player + - `ct` [boolean] True if the player is a CT + - `beingObserved` True if the player is the one being observed + - `observerSlot` The observer ID the player is. *Normally 0-9 but has been converted to 1-10 as the 0th player is on the wrong "side"* + - `health` The player's health. Mostly used to see if the player is dead. ### Example data @@ -282,15 +402,25 @@ _Types available in [./src/types/csgo-gsi.d.ts](../src/types/csgo-gsi.d.ts)_ ] ``` -A cleaned object showing only the necessary information needed to place a player on a mini map. NOT INTERPRETED. - -## teamOne +## teamOne / teamTwo _Types available in [./src/types/extra-data.d.ts](../src/types/extra-data.d.ts)_ ### Data -- `object`: TeamData +- `object` + - `equipmentValue` [number] Total value of all equipment for a team + - `totalMoney` [number] Total amount of money for a team + - `grenades` Total grenades for a team + - `he` [number] Total frag grenades for the team + - `flash` [number] Total flashbangs for the team + - `smoke` [number] Total smoke grenades for the team + - `fire` [number] Total incendiary and molotovs for the team + - `decoy` [number] Total decoy grenades for the team + - `players` [string[]] Array of player Steam IDs + - `score` [number] Current score of team + - `consecutiveRoundLosses` [number] Number of losses to dictate the loss bonus. (From CSGO GSI) + - `matchesWonThisSeries` [number] Amount of matches won in the series. (From CSGO GSI) ### Example data @@ -313,44 +443,22 @@ _Types available in [./src/types/extra-data.d.ts](../src/types/extra-data.d.ts)_ ``` teamOne is the team who is the terrorists in the first half. - -## teamTwo - -_Types available in [./src/types/extra-data.d.ts](../src/types/extra-data.d.ts)_ - -### Data - -- `object`: TeamData - -### Example data - -```JSON -{ - "equipmentValue": 19450, - "totalMoney": 15200, - "grenades": { - "he": 0, - "flash": 0, - "smoke": 0, - "fire": 0, - "decoy": 0 - }, - "players": ["2", "76561197960265730", "76561197960265732", "76561197960265734", "76561197960265735"], - "score": 4, - "consecutiveRoundLosses": 0, - "matchesWonThisSeries": 0 -} -``` - teamTwo is the team who is the counter-terrorists in the first half. ## playerData +Extra player data including game data and steam profile data information not given by CSGO. + _Types available in [./src/types/extra-data.d.ts](../src/types/extra-data.d.ts)_ ### Data -- `object`: PlayerDataAll +- `object` + - `totalDamage` [number] Damage done the entire round so far. Calculated by adding the total round damage at the end of each round. + - `adr` [number] Average Damager per Round. Calculated by taking the `totalDamage` and dividing it by the number of rounds. + - `name` [string] Player name + - `image` [string] URL of Steam profile picture + - `country` [string] Emoji of player's country ### Example data @@ -366,13 +474,14 @@ _Types available in [./src/types/extra-data.d.ts](../src/types/extra-data.d.ts)_ } ``` -Extra player data including game data and steam profile data information not given by CSGO. - ## round30Winner +Intended for internal use. +Due to a bug round wins after round 29 are not logged. This causes an off by one error in the overtime rounds calculator because of round 30. This will record who won round 30 for the internal calulation. It does not log how the round was won only who won it. + ### Data -- `string` +- `string` "T" or "CT" ### Example data @@ -380,15 +489,15 @@ Extra player data including game data and steam profile data information not giv "CT" ``` -Due to a bug round wins after round 29 are not logged. This causes an off by one error in the overtime rounds calculator because of round 30. This will record who won round 30 for the internal calulation. It does not log how the round was won only who won it. - ## HLAE ## hlaeActive ### Data -- `boolean` +If HLAE is active/connected or not. + +- `boolean` True if HLAE is connected ### Example data @@ -396,15 +505,49 @@ Due to a bug round wins after round 29 are not logged. This causes an off by one false ``` -If HLAE is active/connected or not. - ## matchKills +Array of all deaths made in match. Taken raw from HLAE events so some values I may not understand what they represent (Will be designated as "Unknown?"). + _Types available in [./src/types/hlae.d.ts](../src/types/hlae.d.ts)_ ### Data -- `[object]`: PlayerDeath[] +- `[object]`Array + - `name` [number] Event type *(should always be "player_death")* + - `clientTime` [number] Unknown? + - `round` [number] Which round the death took place in + - `keys` + - `assistedflash` [boolean] If the assister was because of a flashbang + - `weapon` [string] The weapon/item used to kill the played + - `weapon_id` [string] Unknown? + - `weapon_fauxitemid` [string] Unknown? + - `weapon_originalowner_xuid` [string] Unknown? (Assume this is if the player picks up a weapon from another player) + - `headshot` [boolean] True if kill was a head shot + - `dominated` [number] 0 or 1. 1 if kill was a domination + - `revenge` [number] 0 or 1. 1 if kill was a revenge kill + - `wipe` [number] 0 or 1. Unknown? + - `penetrated` [number] 0 or 1. 1 if kill was a wallbang + - `noscope`[boolean] True if kill was a noscope + - `thrusmoke`[boolean] True if kill was through a smoke + - `attackerblind`[boolean] True if attacker killed while blind/flashed + - `distance`[number] Distance between attacker and player + - `noreplay` [boolean] Unknown? (Possibly kills in deathmatch where a player can watch a reply of the kill) + - `userid` Player that has died + - `value`[number] Unknown? + - `xuid` [string] Player Steam ID + - `eyeOrigin` [number[3]] Unknown? + - `eyeAngles` [number[3]] Unknown? + - `attacker` Player that has killed the other player + - `value`[number] Unknown? + - `xuid` [string] Player Steam ID + - `eyeOrigin` [number[3]] Unknown? + - `eyeAngles` [number[3]] Unknown? + - `assister` Player that has assisted in the kill + - `value`[number] Unknown? + - `xuid` [string] Player Steam ID + - `eyeOrigin` [number[3]] Unknown? + - `eyeAngles` [number[3]] Unknown? ### Example data @@ -415,10 +558,10 @@ _Types available in [./src/types/hlae.d.ts](../src/types/hlae.d.ts)_ "clientTime": 168.671875, "keys": { "userid": { - "value": 4, - "xuid": "0", - "eyeOrigin": [-373.6505126953125, 1573.7967529296875, -62.60200500488281], - "eyeAngles": [355.6109619140625, 260.3814697265625, 0]}, + "value": 4, + "xuid": "0", + "eyeOrigin": [-373.6505126953125, 1573.7967529296875, -62.60200500488281], + "eyeAngles": [355.6109619140625, 260.3814697265625, 0]}, "attacker": { "value": 5, "xuid": "0", @@ -452,17 +595,25 @@ _Types available in [./src/types/hlae.d.ts](../src/types/hlae.d.ts)_ ] ``` -Array of all deaths made in match. - ## Map Data ## interpMapPlayers +Similar to mapPlayers but the position and rotation are smoothed as the raw values are choppy. + _Types available in [./src/types/map-player.d.ts](../src/types/map-player.d.ts)_ ### Data -- `object`: Record +- `object` + - `string` Key of player's Steam ID + - `steamId` [string] Player's Steam ID + - `position`[number[3]] X, Y and Z location of player + - `rotation`[number[3]] X, Y and Z rotation of player + - `ct` [boolean] True if the player is a CT + - `beingObserved` True if the player is the one being observed + - `observerSlot` The observer ID the player is. *Normally 0-9 but has been converted to 1-10 as the 0th player is on the wrong "side"* + - `health` The player's health. Mostly used to see if the player is dead. ### Example data @@ -480,15 +631,46 @@ _Types available in [./src/types/map-player.d.ts](../src/types/map-player.d.ts)_ } ``` -Similar to mapPlayers but the position and rotation are smoothed as the raw values are choppy. - ## matches +All matches scheduled, the vetos and final score. + _Types available in [./src/types/matches.d.ts](../src/types/matches.d.ts)_ ### Data -- `[object]`: Matches +- `[object]` Array of Match objects + - `id` [string] UUID of match + - `status` [string] Custom match status information (e.g. "Coming Up", "Half Time", "Technical Pause") + - `time` [string] What time the match will be played + - `matchType` [string] How many matches are being played (e.g. "bo1", "bo3", "bo5") + - `teamA` Dictated by which team is selected first in the schedule + - `name` [string] Full team name + - `logo` [string] URL of logo + - `alias` [string] Shorthand form of team name + - `teamB` Dictated by which team is selected second in the schedule + - `name` [string] Full team name + - `logo` [string] URL of logo + - `alias` [string] Shorthand form of team name + - `maps` [Array] Array of all maps veto'd and map scores + - `map` [string] Map name + - `teamVeto` [string] Team name that has selected the map + - `ban` [boolean] True if the map was chosen to be banned + - `side` [string] Which side the other team will choose to start + - `complete` [boolean] True if the match has been finished + - `roundWins` [string[]] String array of how rounds 1 to 29 was won. Taken from CSGO game state integration. *Not beyond round 29 because GSI does not provide that data.* + - `totalScore` Final score of the map + - `teamA` [number] TeamA's score + - `teamB` [number] TeamB's score + - `firstHalf` Score for the first half + - `teamA`[number] TeamA's score + - `teamB`[number] TeamB's score + - `secondHalf`Score for the second half + - `teamA`[number] TeamA's score + - `teamB`[number] TeamB's score + - `ot` Score from an over time + - `teamA`[number] TeamA's score + - `teamB`[number] TeamB's score ### Example data @@ -553,15 +735,15 @@ _Types available in [./src/types/matches.d.ts](../src/types/matches.d.ts)_ ] ``` -All matches scheduled, the vetos and final score. - ## currentMatch +The current match being played. Undefined if no match. + _Types available in [./src/types/matches.d.ts](../src/types/matches.d.ts)_ ### Data -- `object | undefined`: Match | undefined +- `object | undefined`: Match | undefined *(same as the object of [Matches](#matches)*) ### Example data @@ -626,17 +808,29 @@ _Types available in [./src/types/matches.d.ts](../src/types/matches.d.ts)_ } ``` -The current match being played. Undefined if no match. - ## Team/Player assets ## teamPlayerPreset +Data on all imported team and player information. + _Types available in [./src/types/team-preset.d.ts](../src/types/team-preset.d.ts)_ ### Data -- `object`: TeamPreset +- `object` + - `teams` Dictionary that holds all team meta data + - `string` Key using team name + - `name` [string] Full team name + - `logo` [string] URL of logo + - `alias` [string] Shorthand form of team name + - `players` Dictionary that holds all player meta data + - `string` Key using steam id + - `steamId` [string] Steam ID of player + - `realName` [string] Player's real name + - `country` [string] Emoji of player flag + - `profilePicture` [string] URL of profile picture + - `teamName` [string] Team name the player belongs to ### Example data @@ -660,17 +854,34 @@ _Types available in [./src/types/team-preset.d.ts](../src/types/team-preset.d.ts } ``` -Data on all imported team and player information. - ## Tournaments ## tournaments +Dictionary of all tournaments. + _Types available in [./src/types/tournament.d.ts](../src/types/tournament.d.ts)_ ### Data -- `object`: TeamPreset +- `object` + - `string` Key UUID for the tournament + - `id` [string] UUID for the tournament + - `logo` [string] URL for the tournament logo + - `name` [string] Name of the tournament + - `active` [boolean] If the tournament is the current one + - `fixture` [SingleElimination | DoubleElimination] + +#### Single Elimination + +- `type` [string] What tournament type the fixture is *(Should always be "single-elimination")* +- `matches` [string\[]\[]] Array of string arrays to hold match ids. First depth array is rounds and inside rounds are the individual matches + +#### Double Elimination + +- `type` [string] What tournament type the fixture is *(Should always be "double-elimination")* +- `winnerMatches` [string\[]\[]] Array of string arrays to hold winner bracket match ids. First depth array is rounds and inside rounds are the individual matches +- `loserMatches` [string\[]\[]] Array of string arrays to hold loser bracket match ids. First depth array is rounds and inside rounds are the individual matches ### Example data @@ -693,13 +904,13 @@ _Types available in [./src/types/tournament.d.ts](../src/types/tournament.d.ts)_ } ``` -Dictionary of all tournaments. - ## currentTournament +ID of current tournament. Used as a key for the [tournaments](#tournaments) replicant + ### Data -- `string` +- `string` UUID of current tournament ### Example data @@ -707,15 +918,15 @@ Dictionary of all tournaments. "790e8b53-1f3e-4cfe-9913-36ab968bc741" ``` -ID of current tournament. - ## Bundle Data/Settings ## serverRate +How often the server is receiving data from CSGO. + ### Data -- `number` +- `number` Messages per second ### Example data @@ -723,15 +934,16 @@ ID of current tournament. 20 ``` -How often the server is receiving data from CSGO. - ## bundleStatus +Data based on bundle settings. Not used much right now. + _Types available in [./src/types/bundle-status.d.ts](../src/types/bundle-status.d.ts)_ ### Data -- `object`: BundleStatus +- `object` + - `isServerOn` [boolean] Indicates if the manager is listening for CSGO ### Example data @@ -741,15 +953,19 @@ _Types available in [./src/types/bundle-status.d.ts](../src/types/bundle-status. } ``` -Data based on bundle settings. Not used much right now. - ## gameSettings +Some touraments use different timings that graphics may rely on. This can be referenced here + _Types available in [./src/types/game-settings.d.ts](../src/types/game-settings.d.ts)_ ### Data -- `object`: BundleStatus +- `object` + - `bombTime` [number] How long it takes the bomb to explode in seconds + - `bombPlantTime` [number] How long it takes to plant the bomb in seconds + - `noKitDefuseTime` [number] How long it takes to defuse with no kit in seconds + - `kitDefuseTime` [number] How long it takes to defuse with a kit in seconds ### Example data @@ -761,5 +977,3 @@ _Types available in [./src/types/game-settings.d.ts](../src/types/game-settings. "kitDefusedTime": 5, } ``` - -Some touraments use different timings that graphics may rely on. This can be referenced here