Loading...

Game compliance

Competitive integrity is one of our core values, and we work tirelessly to enforce this value, both in-house and with the cooperation of game developers.

NetEase's game compliance policy prevents giving users confidential information like damage and healing statistics, selectively ban heroes, and predict opponents' ultimate abilities. Apps that severely undermine the fairness of the game are deemed as cheating software and will not be allowed during gameplay.

Overwolf’s app policy and game compliance guidelines strictly forbid giving any kind of player advantages in its apps. In addition, apps will also need to comply with the game’s ToS.

Game events API

Please read the overwolf.games.events documentation page to learn how to use Overwolf game events.

Sample Apps

• Marvel Rivals game events sample app

Available Features

• gep_internal
• match_info
• game_info

Game events status

It's highly recommended to communicate errors and warnings to your app users. Check current game event status here or easily check game event status from your app using our API.

gep_internal

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
roster_xx	match_info	A full roster with data during the match.	See notes	269.0
match_id	match_info	The match ID of the current match.	See notes	269.0
game_type	match_info	The current game type.	See notes	269.0
game_mode	match_info	The current game mode.	See notes	269.0
map	match_info	The current played map.	See notes	269.0
player_stats	match_info	Local player's statistics during the match.	See notes	269.0
match_outcome	match_info	Outcome of the current match	See notes	272.0
banned_characters	match_info	The name and IDs of the banned characters in the match	See notes	281.0
ability_cooldown_X	match_info	Abbility cooldown timer in seconds	See notes	282.0
additional_ability_cd_X	match_info	Teamup abbility cooldown timer in seconds	See notes	282.0
objective_progress	match_info	Display the progress data for different game modes	See notes	282.0
game_mode_id	match_info	The current game mode ID.	See notes	287.0
selected_character	match_info	The name and IDs of the highlighted and the selected character	See notes	296.0

roster_xx note

note

The roster index number will change dynamically between 0-11. To keep track of each player, use the UID number or name parameters.

When playing in Competitive mode with Diamond 3 players and above, all player names will be hidden as ***** until the round begins. Once the round starts, player names will be revealed, except for players who have the hidden names option enabled.

List of parameters:

• name - player name
• uid - User ID
• character_name - character name
• character_id - character ID
• team - team number
• is_teammate - is the player one of your teammates true/false
• kills - number of kills
• deaths - number of deaths
• assists - number of assists
• ult_charge - the player's current ultimate ability charge percent (teammates only)
• is_alive - if the player is alive or dead
• is_local - if the player is the local player this paramaters is true
• elo_score - the player's ELO
• is_disconnected - if the player is connected to the match

Data Example:

{"feature": "match_info", "category": "match_info", "key": "roster_11", "data": "{\"uid\":\"1380486120\",\"name\":\"Jack\",\"character_id\":\"1038\",\"team\":0,\"kills\":16,\"deaths\":7,\"assists\":6,\"ult_charge\":0,\"elo_score\":2949,\"is_alive\":false,\"is_teammate\":true,\"is_disconnected\":false,\"is_local\":true,\"character_name\":\"SCARLET WITCH\"}"}

match_id note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "match_id", "data": "5664983_1735659917_267_11001_50"}

game_type note

Possible values:

• Practice
• Quick match
• Competitive
• Arcade

Best practice

If a value is not mapped, it will return "UNKNOWN"

Data Example:

{"feature":"match_info","category":"match_info","key":"game_type","value":"Practice"}

game_mode note

Best practice

If a value is not mapped, it will return "UNKNOWN"

Data Example:

{"feature":"match_info","category":"match_info","key":"game_mode","value":"Practice range"}

map note

Best practice

If a value is not mapped, it will return "UNKNOWN"

Data Example:

{"feature":"match_info","category":"match_info","key":"map","value":"Hall of djaalia"}

player_stats note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "player_stats", "data": "{\"damage_dealt\":952,\"damage_block\":662,\"accuracy\":50,\"total_heal\":0}"}

match_outcome note

Possible values:

• Victory
• Defeat
• Draw

Data Example:

{"info":{"match_info":{"match_outcome":"victory"}},"feature":"match_info"}

banned_characters note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "banned_characters", "data": "[{\"character_id\":\"1041\",\"character_name\":\"WINTER SOLDIER\",\"is_teammate\":false},{\"character_id\":\"1024\",\"character_name\":\"HELA\",\"is_teammate\":true}]"}

ability_cooldown note

Displays the cooldown timer (in seconds) for each ability of the local player, based on the selected character. The X parameter starts at 0 on the left and increases to the right according to the UI.

Data Example:

{"feature": "match_info", "category": "match_info", "key": "ability_cooldown_1", "data": "10"}

additional_ability_cd note

Displays the cooldown timer (in seconds) for each team up ability of the local player, based on the selected character. The X parameter starts at 0 on the left and increases to the right according to the UI.

Data Example:

{"feature": "match_info", "category": "match_info", "key": "additional_ability_cd_0", "data": "10"}

objective_progress note

Parameters list:

• game_mode - the selected game mode
  • Convoy
  • Convergence
  • Domination
• checkpoint – The number of checkpoints reached by the attacking team in the current round.
• left_capture / right_capture – Valid only in Domination game mode. indicates the capture percentage for the respective point.
• team - Defense / Attacker

Data Example:

{"feature": "match_info", "category": "match_info", "key": "objective_progress", "data": "{\"game_mode\":\"Convoy\",\"checkpoint\":0,\"left_capture\":0,\"right_capture\":0,\"team\":\"Defense\"}"}

game_mode_id note

Data Example:

{"feature":"match_info","category":"match_info","key":"game_mode_id","value":"1392"}

selected_character note

Data Example:

{"feature":"match_info","category":"match_info","key":"selected_character","value":"[{\"character_id\":1047,\"character_name\":\"JEFF THE LAND SHARK\"}]"}

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	The match started	See notes	269.0
match_end	null	The match ended	See notes	269.0
round_start	null	Round started.	See notes	271.0
round_end	null	Round ended.	See notes	271.0
death	The total number of deaths	The player is dead	See notes	269.0
kill	The total number of kills	The player killed another player	See notes	269.0
assist	The total number of assists	The player assisted another player	See notes	269.0
kill_feed	The name of the attacker and victim	Anytime a player dies in the match.	See notes	269.0

match_start note

Data Example:

{"events":[{"name":"match_start","data":""}]}

match_end note

Data Example:

{"events":[{"name":"match_end","data":""}]}

round_start note

Data Example:

{"name":"round_start","data":""}

round_end note

Data Example:

{"name":"round_end","data":""}

death note

Data Example:

{"events":[{"name":"death","data":3}]}

kill note

Data Example:

{"events":[{"name":"kill","data":4}]}

assist note

Data Example:

{"events":[{"name":"assist","data":1}]}

kill_feed note

Data Example:

["events": {"name": "kill_feed","data": "{\"attacker\":\"Overwolf\",\"victim\":\"Underwolf}"}]

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene	game_info	The name of the current scene.	See notes	269.0
player_name	game_info	The local player name	See notes	269.0
player_id	game_info	the local player's ID	See notes	270.0

scene note

List of possible values:

• Lobby
• Ingame

Data Example:

{"info":{"game_info":{"scene":"Lobby"}},"feature":"game_info"}

player_name note

Data Example:

{"info":{"game_info":{"player_name":"Overwolf"}},"feature":"game_info"}

player_id note

Data Example:

{"info":{"game_info":{"player_id":"1380486120"}},"feature":"game_info"}

Events status

Loading...