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 API

Returns an object with events and functions related to game launcher status.

Methods Reference

  • overwolf.games.launchers.getRunningLaunchersInfo()

Events Reference

  • overwolf.games.launchers.onUpdated
  • overwolf.games.launchers.onLaunched
  • overwolf.games.launchers.onTerminated

Types Reference

  • overwolf.games.launchers.GetRunningLaunchersInfoResult Object
  • overwolf.games.launchers.UpdatedEvent Object
  • overwolf.games.launchers.LauncherInfo Object
  • overwolf.games.launchers.Position Object

getRunningLaunchersInfo(callback)

Version added: 0.103

Returns an object with information about currently running launchers.

ParameterTypeDescription
callback(Result:GetRunningLaunchersInfoResult) => voidCalled with the currently running detected launchers

onUpdated

Version added: 0.103

Fired when launcher info is updated, with the following structure: UpdatedEvent Object.

onLaunched

Version added: 0.103

Fired when a launcher has launched, with the following structure: LauncherInfo Object.

onTerminated

Version added: 0.103

Fired when a launcher is closed, with the following structure: LauncherInfo Object.

GetRunningLaunchersInfoResult Object

ParameterTypeDescription
successboolean
errorstringnull if success is true
launchersLauncherInfo[]an array of currently running detected launchers

Example data: Success

{  
   "success": true,
   "launchers":[  
      {  
         "title":"League of Legends Launcher",
         "id":54271,
         "classId":5427,
         "isInFocus":false,
         "position":{  
            "top":252,
            "left":2066,
            "width":1280,
            "height":720
         },
         "handle":329882,
         "commandLine":"E:/Games/RADS/projects/league_client/releases/0.0.0.65/deploy/LeagueClientUx.exe "--release=0.0.0.35" "--remoting-auth-token=scIN957coAwcbo0WW78nzg" "--rads-product-directory=E:/Games/RADS/solutions/league_client_sln/releases/0.0.0.35/deploy/" "--respawn-command=LeagueClient.exe" "--respawn-display-name=League of Legends" "--app-port=57610" "--install-directory=E:/Games/" "--app-name=LeagueClient" "--ux-name=LeagueClientUx" "--ux-helper-name=LeagueClientUxHelper" "--log-dir=LeagueClient Logs" "--bugsplat-name=league_client_riotgames_com" "--bugsplat-platform-id=EUW1" "--project=LeagueClient" "--app-log-file-path=E:/Games/Logs/LeagueClient Logs/2017-04-20T11-12-28_9576_LeagueClient.log" "--app-pid=9576"",
         "processId":1468,
         "path":"E:/Games/RADS/projects/league_client/releases/0.0.0.65/deploy/LeagueClientUx.exe"
      }
   ]
}

LauncherInfo Object

ParameterTypeDescription
titlestring
idnumber
classIdnumber
isInFocusboolean
positionPosition object
handlenumber
commandLinestring
processIdnumber
pathstring

Position Object

Returns the launcher’s window position

ParameterTypeDescription
heightnumber
leftnumber
topnumber
widthnumber

UpdatedEvent Object

ParameterTypeDescriptionNotes
infoLauncherInfo ObjectLauncher info data
changeTypestring[]New game info data

Event data example: Success

"info":
   {  
         "title":"League of Legends Launcher",
         "id":54271,
         "classId":5427,
         "isInFocus":false,
         "position":{  
            "top":252,
            "left":2066,
            "width":1280,
            "height":720
         },
         "handle":329882,
         "commandLine":"E:/Games/RADS/projects/league_client/releases/0.0.0.65/deploy/LeagueClientUx.exe",
         "processId":1468,
         "path":"E:/Games/RADS/projects/league_client/releases/0.0.0.65/deploy/LeagueClientUx.exe"
   },
"changeType":
   {
     //including game name, game running, game terminated, game changing focus, etc.
   }
Last updated on 2020-10-21 by eransharv
← overwolf.games.inputTrackingoverwolf.games.launchers.events →
  • Methods Reference
  • Events Reference
  • Types Reference
  • getRunningLaunchersInfo(callback)
  • onUpdated
  • onLaunched
  • onTerminated
  • GetRunningLaunchersInfoResult Object
  • LauncherInfo Object
  • Position Object
  • UpdatedEvent 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