Overview

Electron APIs / packages

Provides access to all available Overwolf APIs bundled in the Electron Overwolf Packages management.

This interface extends overwolf.packages.OverwolfPackageManager and consolidates access to key subsystems such as:

• recorder—video capture and replay features
• overlay—in-game overlay window management and hotkeys
• utility—game tracking and scanning utilities
• crn—crash report and notification system
• gep—subscribe to real-time in-game events and info updates from supported games.

It acts as a unified entry point for interacting with Overwolf's capabilities within a packaged app.

Example

const app = overwolf.packages as OWPackages;

// Start tracking game launch/exit events
app.utility.trackGames({ includeUnsupported: true });

// Register for game launch
app.utility.on("game-launched", (gameInfo) => {
  console.log("Game launched:", gameInfo.name);
});

// Start recording
await app.recorder.startRecording({
  filePath: "C:/Videos/gameplay",
  audioTrack: 1,
});

Interfaces

Interface	Description
ChannelPackageInfo	Passed to the ready callback of setChannel(). Identifies the downloaded package that is pending a restart.
OverwolfPackageManager	Overwolf Package Manager interface.
OWPackages	-
PackageInfo	Package info

Type Aliases

Type Alias	Description
AvailableChannelsResult	Returned by getAvailableChannels(). Maps each package name to the list of channel names available on the server. Packages with no channels defined return an empty array.
CurrentChannelsResult	Returned by getChannel(). Maps each package name to its currently active channel. 'public' means the package is on the default public release.
PackageName	A fake enum for all built-in package names
PendingUpdatesResult	-
SetChannelResult	Result returned by setChannel(). error is 'invalid-package' when the package is not found on the server, or 'invalid-channel' when the channel does not exist for that package.