Loading...

Game events API

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

Sample Apps

• Minecraft Bedrock game events sample app

Available Features

• gep_internal
• game_info
• match_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.

gep_internal

Info Updates

key	Category	Values	Notes	Since GEP Ver.
gep_internal	gep_internal	Local + Public version number	See notes	143.0

gep_internal note

Data Example:

{"info":{"gep_internal":{"version_info":"{"local_version":"157.0.1","public_version":"157.0.1","is_updated":true}"}},"feature":"gep_internal"}

game_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
scene_key	game_info	The key of the current scene.	See notes	289.0
name	game_info	The name of the local player.	See notes	289.0
world_id	game_info	The original name of a single-player world.	See notes	289.0

scene_key note

Data Example:

{"feature": "game_info", "category": "game_info", "key": "scene_key", "data": "pause_screen"}
{"feature": "game_info", "category": "game_info", "key": "scene_key", "data": "in_game_play_screen"}

name note

Data Example:

{"info":{"game_info":{"name":"OverwoldDeBest"}},"feature":"game_info"}

world_id note

Data Example:

{"feature": "game_info", "category": "game_info", "key": "world_id", "data": "my new world"}```

match_info

Info Updates

key	Category	Values	Notes	Since GEP Ver.
server	match_info	The full id of the server.	See notes	289.0
realms_info	match_info	The ID and name of the current realm.	See notes	289.0
location	match_info	Current player's location in the game.	See notes	289.0
facing	match_info	The current direction the player is facing.	See notes	289.0
biome	match_info	Name of the biome the player is in currently.	See notes	289.0
dimension	match_info	Name of the dimension the player is in currently.	See notes	289.0

Events

Event	Event Data	Fired When	Notes	Since GEP Ver.
match_start	null	When loading into a map.	See notes	289.0
match_end	null	When disconnecting from map.	See notes	289.0

server note

Data Example:

{"info":{"match_info":{"server":"Play.datblock.com"}},"feature":"match_info"}

realms_info note

note

realms_info does not work when entering a realm using the Quick Launch option in the launcher

Data Example:

{"feature":"match_info","category":"match_info","key":"realms_info","value":"{\"realms_id\":14293560,\"realms_name\":\"New World\"}"}

location note

Data Example:

{"info":{"match_info":{"location":"{"x":-289.403,"y":60.9237,"z":474.063}"}},"feature":"match_info"}
{"info":{"match_info":{"location":"{"x":-289.669,"y":60.4237,"z":475.049}"}},"feature":"match_info"}
{"info":{"match_info":{"location":"{"x":-290.248,"y":59.9237,"z":476.861}"}},"feature":"match_info"}
{"info":{"match_info":{"location":"{"x":-290.754,"y":59.4237,"z":478.788}"}},"feature":"match_info"}

facing note

Data Example:

{"info":{"match_info":{"facing":"{"x":146.851,"y":1.34979}"}},"feature":"match_info"}

biome note

Data Example:

{"feature":"match_info","category":"match_info","key":"biome","value":"ice_plains"}

dimension note

Data Example:

{"feature": "match_info", "category": "match_info", "key": "dimension", "data": "overworld"}

match_start note

Data Example:

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

match_end note

Data Example:

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

Events status

Loading...