Loading...

Game events API

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

Sample Apps

• Slay the Spire 2 game events sample app

Available Features

• match_info
• player_info

Game event status

It is highly recommended to communicate errors and warnings to app users.

Check the current game event status here. Alternatively, you can easily check that status from your app itself, using our API.

match_info

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start		In the beginning of each match	See notes	316.0
match_end		At the end of each match	See notes	316.0
match_outcome	The run's result and stats	When the run is won or lost	See notes	316.0
map_opened	Whether travel is enabled	When the map is opened	See notes	316.0
map_closed	Whether the player is traveling	When the map is closed	See notes	316.0
shop_opened		When the shop is opened	See notes	316.0
shop_closed		When the shop is closed	See notes	316.0

match_start note

Data Example:

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

match_end note

Data Example:

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

match_outcome note

The event data is a JSON string with these fields:

• result – The result of the run (e.g. defeat)
• floors – The number of floors reached
• gold_gained – The amount of gold gained during the run
• killed_by – What killed the player (id and type). Only sent when the player was killed

Data Example:

{"events":[{"name":"match_outcome","data":"{\"floors\":2,\"gold_gained\":150,\"killed_by\":{\"id\":\"SLIMES_WEAK\",\"type\":\"encounter\"},\"result\":\"defeat\"}"}]}

map_opened note

The event data is a JSON string with these fields:

• travel_enabled – Whether the player can travel on the map

Data Example:

{"events":[{"name":"map_opened","data":"{\"travel_enabled\":true}"}]}

map_closed note

The event data is a JSON string with these fields:

• traveling – Whether the player is traveling

Data Example:

{"events":[{"name":"map_closed","data":"{\"traveling\":false}"}]}

shop_opened note

Data Example:

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

shop_closed note

Data Example:

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

Info Updates

key	Category	Values	Notes	Since GEP Ver.
seed	match_info	The seed of the current run	Reset to null at the end of the run. See notes	316.0
game_type	match_info	The type of the current run	Reset to null at the end of the run. See notes	316.0
scene	match_info	The current scene	See notes	316.0

seed note

Data Example:

{"info":{"match_info":{"seed":"RC37TEK7D4"}},"feature":"match_info"}

game_type note

Data Example:

{"info":{"match_info":{"game_type":"standard"}},"feature":"match_info"}

scene note

Data Example:

{"info":{"match_info":{"scene":"combat"}},"feature":"match_info"}

player_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
hp	player_info	The player's current and max HP	See notes	316.0
character	player_info	The player's character and ascension level	Reset to null at the end of the run. See notes	316.0

hp note

Data Example:

{"info":{"player_info":{"hp":"{\"current\":73,\"max\":80}"}},"feature":"player_info"}

character note

Data Example:

{"info":{"player_info":{"character":"{\"ascension\":0,\"name\":\"IRONCLAD\"}"}},"feature":"player_info"}

Events status

Loading...