Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›overwolf.games

API Reference

  • Changelog
  • Overview

App Manifest

  • manifest.json
  • Validate your manifest

Available Game Events

  • Games IDs
  • Apex Legends
  • Call of Duty: Warzone
  • CS:GO
  • Dota 2
  • Final Fantasy XIV
  • Dota Underlords
  • Escape From Tarkov
  • Fortnite
  • Hearthstone
  • Heroes of the Storm
  • Legends of Runeterra
  • League of Legends
  • Minecraft
  • MTG Arena
  • Overwatch
  • Path of Exile
  • PUBG
  • PUBG Lite
  • Rainbow Six Siege
  • Rocket League
  • StarCraft II
  • Teamfight Tactics
  • Valorant
  • World of Tanks
  • World of Warcraft
  • World of Warships
  • Warframe
  • Various External APIs

Game Launchers Events

  • Launchers IDs
  • LOL Launcher

overwolf.benchmarking

  • overwolf.benchmarking

overwolf.campaigns

  • overwolf.campaigns.crossapp

overwolf.cryptography

  • overwolf.cryptography

overwolf.extensions

  • overwolf.extensions
  • overwolf.extensions.current
  • overwolf.extensions.sharedData
  • overwolf.extensions.io

overwolf.games

  • overwolf.games
  • overwolf.games.events
  • overwolf.games.inputTracking
  • overwolf.games.launchers
  • overwolf.games.launchers.events

overwolf.io

  • overwolf.io
  • overwolf.io.paths

overwolf.logitech

  • overwolf.logitech
  • overwolf.logitech.arx
  • overwolf.logitech.led

overwolf.media

  • overwolf.media
  • overwolf.media.audio
  • overwolf.media.replays
  • overwolf.media.videos
  • Highlights supported games

overwolf.os

  • overwolf.os
  • overwolf.os.tray

overwolf.profile

  • overwolf.profile
  • overwolf.profile.subscriptions

overwolf.settings

  • overwolf.settings
  • overwolf.settings.hotkeys
  • overwolf.settings.language
  • overwolf.settings.games

overwolf.social

  • overwolf.social
  • overwolf.social.reddit
  • overwolf.social.youtube
  • overwolf.social.discord
  • overwolf.social.gfycat
  • overwolf.social.twitter

overwolf.streaming

  • overwolf.streaming

overwolf.tobii

  • overwolf.tobii

overwolf.utils

  • overwolf.utils

overwolf.web

  • overwolf.web
  • overwolf.web.webserver
  • overwolf.web.websocket

overwolf.windows

  • overwolf.windows
Edit

overwolf.games.launchers.events API

Returns an object with launcher related events and info-updates (Currently supported only for the League of Legends Launcher).

Methods Reference

  • overwolf.games.launchers.events.setRequiredFeatures()
  • overwolf.games.launchers.events.getInfo()

Events Reference

  • overwolf.games.launchers.events.onInfoUpdates
  • overwolf.games.launchers.events.onNewEvents

Types Reference

  • overwolf.games.launchers.events.SetRequiredFeaturesResult Object
  • overwolf.games.launchers.events.GetInfoResult Object

How to register for features

The Launcher Events Provider keeps an info DB with information about the launcher state.

Updates for these entries can be received as events by registering an event listener using overwolf.games.launchers.events.onInfoUpdates().

It is also possible to get the currently available information using overwolf.games.launchers.events.getInfo().

setRequiredFeatures(launcherClassId, features, callback)

Version added: 0.126

Sets the required features from the provider.

ParameterTypeDescription
launcherClassIdintLauncher ID of interest
featuresstringString array of features to utilize
callback(Result: SetRequiredFeaturesResult) => voidReturns with the result

getInfo(launcherClassId, callback)

Version added: 0.126

Gets the current information for a given launcher id.

ParameterTypeDescription
launcherClassIdintThe launcher Id of interest
callback(Result: GetInfoResult) => voidReturns with the result

onInfoUpdates

Version added: 0.78

Fired when there are game info updates with a JSON object of the updates.

onNewEvents

Version added: 0.78

Fired when there are new game events with a JSON object of the events.

SetRequiredFeaturesResult Object

ParameterTypeDescription
successboolean
errorstringnull if success is true
supportedFeaturesstring[]an array of supported features

Example data: Success

{"success": true, "supportedFeatures": Array[1])}

GetInfoResult Object

ParameterTypeDescription
successboolean
errorstringnull if success is true
resobjectProvides the current game info

Example data: Success

{  
   "success":true,
   "res":{  
      "game_flow":{  
         "phase":"None"
      },
      "summoner_info":{  
         "account_id":"224346939",
         "display_name":"itaygl",
         "internal_name":"itaygl",
         "profile_icon_id":"3902",
         "summoner_id":"79489298",
         "summoner_level":"31"
      },
      "game_info": {
         "close_client_during_game": "0"
      },
      "credentials": {
         "token": "cmlvdDpxb2hlamFqeHRzRUI4dGw1TUljSmJR",
         "port": "65038"
      }

   }
}

Example data: Failure

{
   "success": false, 
   "error": "Launcher isn't running or the associated game isn't running"
}
Last updated on 2020-4-4 by eransharv
← overwolf.games.launchersoverwolf.io →
  • Methods Reference
  • Events Reference
  • Types Reference
  • How to register for features
  • setRequiredFeatures(launcherClassId, features, callback)
  • getInfo(launcherClassId, callback)
  • onInfoUpdates
  • onNewEvents
  • SetRequiredFeaturesResult Object
  • GetInfoResult Object
  • Legal
  • Terms overview
  • Developer's terms
  • App terms
  • Overwolf terms
  • Overwolf Privacy policy
  • Support
  • Questions and Answers
  • Discord
  • Slack
  • Facebook
  • Twitter
  • Documentation
  • Changelog
  • API
  • App Creation Process
  • Best Practices
  • Game Events status
  • Information
  • Careers
  • Fund
  • Developers Blog
  • Overwolf Appstore
  • Advertise on Overwolf