Games IDs
Overwolf supported game definition
In Overwolf, the term supported game means:
- Overlay support—games that support overlay injection. In these games, OW apps are displayed as an overlay making use of Overwolf APIs. For a list of games that support overlay, see gamelist.xml file.
- Game events support—games which support overlay injection as well as real-time game events.
You can create OW apps that leverage game events using the
overwolf.games.events
API. For a list of games that support events, see Game events status.
Game events can vary between games. Contact us if you want to enable a new game event.
What is the Game ID
Each supported game has its own unique Game ID.
Game IDs are properties are used in your app’s manifest.json
:
-
game_targeting
—list of games which enable overlay for this app. -
game_events
—list of games for which game events are required. -
launch_events
—list of games triggering the app to launch.
gamelist.xml
file
Overwolf supports overlay injection in numerous amounts of games. You can find the most updated list it in your local Overwolf app data folder after installing or updating the Overwolf client. To view the gamelist.xml
:
- Navigate to your
%localappdata%
folder and open theoverwolf
folder. - Open
gameList.xml
(named with a number postfix, for example, gamelistXXX.xml, higher number means newer version), and search for your game by name. - Under each game, you can find game ID listed. If thew game you are looking for is not listed, contact us for more details.
Game-ID and Instance-ID
A single game can have multiple executables, for example Steam, GOG, 32 / 64-bit clients, and others. Overwolf differentiates between them by adding one digit to each game ID, which is called an Instance ID so that you have the base game ID, and then a series of instances (for example212160, 212161, …).
When you call overwolf.games.onGameInfoUpdated
you will get the full ID including the instance ID. The gamelist.xml
file in the OW client folder that contains all the supported game ids, including instance ID. In order to translate the instance ID into the game ID that needs to be used in the manifest,json
, you can divide the instance ID by 10 and round down.
Use the following code snippet to turn instance ID 212161
into the game ID 21216
(Fortnite):
Math.floor(gameInfoResult.gameInfo.id/10)
You can see how it is used in the Fortnite events sample app.
The RunningGameInfo object
also has a classId
property, which already equals the game ID.
Game launcher IDs
Launcher IDs can be used to auto-launch your app when a game launcher starts (currently only available for League of Legends launcher id 10902).
Add the Launcher Id to the launch_events
property in your app’s manifest.json
file.
This snippet auto-launches you app when the League of Legends client starts and the app’s main window is minimized. Change this by using start_minimized
false).
"launch_events": [
{
"event": "GameLaunch",
"event_data": {
"game_ids": [10902]
},
"start_minimized": true
}
]