Skip to main content

Dev Mode

Run and test the gaming packages (GEP, Overlay, Recorder) during local development, before your app is signed or packaged.

To make those packages load in a build you distribute to users, see App Signing.

PropertyValue
SurfaceOverwolf Electron (ow-electron)
Minimum versionow-electron 39.8.x
PlatformWindows
When to useLocal development, before the app is signed or packaged
CredentialsAn Overwolf Console account, plus an API key or a dev token. See Set up dev credentials.

What dev mode is​

Dev mode is a path in the package manager (owepm) that skips most production integrity checks. It is built for local development, before your app is signed and packaged.

Dev mode can't activate on a distributed or packaged app. If any condition is false, the app routes to the production validation path, where a missing or invalid signature stops gaming packages from loading. For that path, see App Signing.

Dev mode authentication​

Even in dev mode, you authenticate with Overwolf before gaming packages load.

If OW_CLI_EMAIL, OW_CLI_API_KEY, or OW_DEV_KEY are all absent, dev mode credential verification fails and gaming packages don't load. The app itself still runs.

Dev credentials and variables​

VariablePurposeSource
OW_CLI_EMAILDev mode credential checkYour Overwolf Console account email
OW_CLI_API_KEYDev mode credential checkOverwolf Console, under Profile > API Keys
OW_DEV_KEYAlternative dev credential. Replaces OW_CLI_EMAIL and OW_CLI_API_KEY for runtime verificationProvided by Overwolf to an approved developer who doesn't yet have Overwolf Console access (a temporary developer)

Set up dev credentials​

Use one of the options below. Environment variables take precedence over the credentials file.

Option A: Environment variables​

Recommended for CI and most dev workflows. Set the variables before launching your app in dev mode.

# Linux / macOS
export OW_CLI_EMAIL=your-email@example.com
export OW_CLI_API_KEY=your-api-key-from-console
# Windows (PowerShell)
$env:OW_CLI_EMAIL = "your-email@example.com"
$env:OW_CLI_API_KEY = "your-api-key-from-console"

Or use the alternative dev token:

export OW_DEV_KEY=your-dev-token-from-dev-site
$env:OW_DEV_KEY = "your-dev-token-from-dev-site"

Option B: Credentials file​

Run the CLI config command (requires @overwolf/ow-cli installed):

ow config
# Follow the prompts to enter your email and API key

This writes to ~/.ow/credentials:

[default]
email=your-email@example.com
apiKey=your-api-key-from-console

The credentials service reads this file when the environment variables aren't set. You can keep multiple profiles. The default profile is used unless overridden.

Option C: OW_DEV_KEY​

OW_DEV_KEY is provided by Overwolf to an approved developer who doesn't yet have Overwolf Console access (a temporary developer). If Overwolf gave you a dev token, set it directly:

export OW_DEV_KEY=<your-dev-token>

OW_DEV_KEY is equivalent to OW_CLI_EMAIL:OW_CLI_API_KEY for dev mode verification. It uses Bearer authentication instead of Key.

Precedence order​

OW_CLI_EMAIL env var (highest)
  -> OW_CLI_API_KEY env var
    -> credentials file [default] profile
      -> OW_DEV_KEY env var (alternative path, not combined with the above)

What runs in dev mode​

With valid dev credentials, a dev-mode build runs the full gaming package set: GEP (game events), Overlay, Recorder. Without credentials, the app runs but the gaming packages don't load.