Skip to main content

manifest.json

Welcome to the manifest.json file

This JSON formatted file is responsible for describing aspects of your app. This includes your app's name, window size, tranparency settings and more basic settings for how your app operates. This is a mandatory file which has to exist in the root folder for your app. Here you can see a basic version of the manifest.json file.

manifest.json with fields summary

The following code shows supported manifest fields for Overwolf apps, with links to the section that discusses each field. Note that not all flags are mandatory - we included all available flags for documentation purposes.

Use this manifest with Overwolf client version 0.141 and above

{
//Mandatory
"manifest_version": 1,
"type": "WebApp",
//Mandatory, The app metadata
"meta": {
"name": "Name of your app",
"author": "Author name",
"version": "1.2.3.456",
"minimum-overwolf-version": "128.0.0.1",
"minimum-gep-version": "128.0.0.1",
"description": "A plain text description",
"dock_button_title": "Short name of your app",
"icon": "iconMouseOver.png",
"icon_gray": "iconMouseNormal.png",
"launcher_icon": "icon.ico",
"splash_image": "splashIcon.png",
"window_icon": "windowIcon.png"
},
//An array of permissions that the app requires
"permissions": ["Streaming","Hotkeys","GameInfo"],
"max_rotation_log_files": 20,
//Mandatory, a list of additional meta-data on the app
"data": {
//An app can declare itself as targeted to one game or more
"game_targeting": {"type": "dedicated","game_ids": [10906, 7764]},
//The name of the window (from the “windows” list) initially loaded when the app starts
"start_window": "windowName",
"enable_top_isolation": true,
//A map from window names to window settings
"windows": {
"windowName": {
//Mandatory. Points to the file to be loaded inside the window
"file": "name.html",
"show_in_taskbar": true,
"transparent": true,
"override_on_update": true,
"resizable": false,
"show_minimize": true,
"clickthrough": false,
"style": "inputPassThrough",
"disable_rightclick": false,
"forcecapture": false,
"show_only_on_stream": false,
"ignore_keyboard_events": false,
"in_game_only": false,
"desktop_only": false,
"disable_restore_animation": false,
"grab_keyboard_focus": false,
"size": {...},
"min_size": {...},
"max_size": {...},
"start_position": {...},
"topmost": false,
"bottommost": false,
"block_top_window_navigation": true,
"keep_window_location": true,
"use_os_windowing": false,
"background_optimization": true,
"mute": true,
"mute_excluded_hosts": ["..."],
"popup_blocker": false,
"show_maximize": true,
"disable_blur": false,
"native_window": false,
"is_background_page": true,
"focus_game_takeover": "ReleaseOnLostFocus",
"focus_game_takeover_release_hotkey": "...",
"allow_local_file_access": true,
"is_alt_f4_blocked": false,
"dev_tools_window_style": false,
"debug_url": "http://localhost:3000",
"optimize_accelerate_rendering": false, //Use directly shared texture rendering in game (only DX11)
"disable_auto_dpi_sizing": false, //disable the DPI Aware behavior of native windows
"restrict_to_game_bounds": false, //Restrict window to game client (window) area.
"disable_hardware_acceleration": false, // disable GPU hardware acceleration. Relevant only to native windows
"open_dev_tools": true //Used for debugging, automatically opens the dev tools when the app window opens
},
},
//Toggle printing of ads log to the console
"enable_top_isolated_sites_console": false,
//External URLs the web app should be able to access
"externally_connectable": { "matches": ["http://*.overwolf.com", "https://*.overwolf.com", "https://*.google-analytics.com"] },
//Override the relative protocol with a preferred one
"protocol_override_domains": {"domain.com": "http","ajax.googleapis.com": "https"},
//Causes links in the app to be opened using the user’s default browser ("user") or Overwolf’s browser ("overwolf")
"force_browser": "user"/"overwolf",
//Enable OSR|GPU acceleration if supported by this machine
"enable_osr_acceleration": true,
//A list of game ids for which game events are required
"game_events": [...],
//Disable the log file 1000 lines limitation. Don't enable it without Overwolf approval.
"disable_log_limit": false,
//Allows the access of custom plugin dlls
"extra-objects": {"my-plugin":{"file":"plugins/my_plugin.dll","class":"MyPlugin.EntryPoint"}},
//shortcut keys that trigger an app action
"hotkeys":{"save_YourAppName": {"title": "Save Replay for later", "action-type":"custom", "default":"Ctrl+Shift+F9"}},
//A list of content scripts to be loaded for specific windows
"content_scripts": [{ "windows": [ "index" ], "js": [ "myscript.js" ] }],
//A list of events causing the app to launch
"launch_events": [{"event": "GameLaunch", "event_data":{"game_ids": [1136]}, "start_minimized": true}],
//A custom user agent for the app to use when creating http requests. Don’t use this property if your app serves ads.
"user_agent": "...",
//Disable opening of the developer tools for the app
"disable_dt": false,
//hosting app flexible data
"service_providers": {"nafihghfcpikebhfhdhljejkcifgbdahdhngepfb": {"whatever": "value"}},
//Additional setting for developers (only when the app is in dev mode)
"<a id="developer-manifest" href="#developer-game-settings">developer": {
//Enable auto App reloading when detecting local files changes.True by Default
"enable_auto_refresh": true,
//Reload delay (in ms) when detecting file changes (for multiple change)default is 1000 (1 second)
"reload_delay": 1000,
//Filter files which will be tracked.e.g (*.js;*.html)Default: all files (*.*)
"filter": "*.json;*.html"
},
//If set to true, app local data will not be cleaned up after app uninstallation
"disable_cleanup": true,
"process_name": "my sample app",
"url_protocol": {"scheme": "testscheme"},
"uninstall_window": {
//if exists, the client will run this window in the background for the required time before actually uninstalling an app.
"file": "name.html",
//exactly as other overwolf windows. this window should not display UI as it runs in the background.
"required_runtime": 1000,
//if not defined, the default is 10 seconds. valid up to 60000 (1 minute).
},
"auto_relaunch_on_crash": true,
//Automatically relaunches the app if it crashes up to 5 times.
"open_dev_tools": true
//Used for debugging, automatically opens the dev tools when an app window opens
}
}

manifest.json without fields summary

Here you can see the same manifest.json file, but without comments

Use this manifest with Overwolf client version 0.141 and above

{
"manifest_version": 1,
"type": "WebApp",
"meta": {
"name": "Name of your app",
"author": "Author name",
"version": "1.2.3.456",
"minimum-overwolf-version": "128.0.0.1",
"minimum-gep-version": "128.0.0.1",
"description": "A plain text description",
"dock_button_title": "Short name of your app",
"icon": "iconMouseOver.png",
"icon_gray": "iconMouseNormal.png",
"launcher_icon": "icon.ico",
"splash_image": "splashIcon.png",
"window_icon": "windowIcon.png"
},
"permissions": ["Streaming","Hotkeys","GameInfo"],
"enable_top_isolation": true,
"max_rotation_log_files": 20,
"data": {
"game_targeting": {"type": "dedicated","game_ids": [10906, 7764]},
"start_window": "windowName",
"windows": {
"windowName": {
"file": "name.html",
"show_in_taskbar": true,
"transparent": true,
"resizable": false,
"show_minimize": true,
"clickthrough": false,
"style": "inputPassThrough",
"disable_rightclick": false,
"forcecapture": false,
"show_only_on_stream": false,
"ignore_keyboard_events": false,
"in_game_only": false,
"desktop_only": false,
"disable_restore_animation": false,
"grab_keyboard_focus": false,
"grab_focus_on_desktop": false,
"size": {...},
"min_size": {...},
"max_size": {...},
"start_position": {...},
"topmost": false,
"bottommost": false,
"block_top_window_navigation": true,
"keep_window_location": true,
"use_os_windowing": false,
"background_optimization": true,
"mute": true,
"mute_excluded_hosts": ["..."],
"popup_blocker": false,
"show_maximize": true,
"disable_blur": false,
"native_window": false,
"is_background_page": true,
"focus_game_takeover": "ReleaseOnLostFocus",
"focus_game_takeover_release_hotkey": "...",
"allow_local_file_access": true,
"is_alt_f4_blocked": false,
"dev_tools_window_style": false,
"debug_url": "http://localhost:3000",
"optimize_accelerate_rendering": false,
"disable_auto_dpi_sizing": false,
"restrict_to_game_bounds": false,
"disable_hardware_acceleration": false
},
},
"enable_top_isolated_sites_console": false,
"externally_connectable": { "matches": ["http://*.overwolf.com", "https://*.overwolf.com", "https://*.google-analytics.com"] },
"protocol_override_domains": {"domain.com": "http","ajax.googleapis.com": "https"},
"force_browser": "user"/"overwolf",
"enable_osr_acceleration": true,
"game_events": [...],
"disable_log_limit": false,
"extra-objects": {"my-plugin":{"file":"plugins/my_plugin.dll","class":"MyPlugin.EntryPoint"}},
"hotkeys":{"save_YourAppName": {"title": "Save Replay for later", "action-type":"custom", "default":"Ctrl+Shift+F9"}},
"content_scripts": [{ "windows": [ "index" ], "js": [ "myscript.js" ] }],
"launch_events": [{"event": "GameLaunch", "event_data":{"game_ids": [1136]}, "start_minimized": true}],
"user_agent": "...",
"disable_dt": false,
"service_providers": {"nafihghfcpikebhfhdhljejkcifgbdahdhngepfb": {"whatever": "value"}},
"<a id="developer-manifest" href="#developer-game-settings">developer": {
"enable_auto_refresh": true,
"reload_delay": 1000,
"filter": "*.json;*.html"
},
"disable_cleanup": true,
"process_name": "my sample app",
"url_protocol": {"scheme": "testscheme"},
"uninstall_window": {
"file": "name.html",
"required_runtime": 1000,
}
}
}

Validate your manifest.json

To help you make sure that your manifest file is correct and complete, validate it against our schema file.

Please read all the info in our schema validation best practice.

Access the manifest from your app

You can read the manifest JSON from your app's code using the overwolf.extensions.getManifest() function.

Top manifest objects

There are many features enabled through this file. Some are mandatory (marked accordingly), others optional. Below is a description of features you can activate through the manifest.json :

NameTypeDescription
manifest_versionintegerMandatory. Targets the manifest version you are working on. Currently there is only one version, therefore this value is always "1"
typestringMandatory. Declares the type of application. Can only be "WebApp"
metameta ObjectMandatory. The app metadata
permissionspermissions[]An array of permissions that the app requires
datawebapp settings ObjectMandatory. App data. Changes between different apps types. Currently can only be from type webapp settings

Permissions array

To use most overwolf.* APIs, your Overwolf app must declare relevant permissions in the relevant manifest.json field. It's an array of permissions that the app requires:

"permissions": ["Streaming","Hotkeys","GameInfo"]
PermissionDescription
"Camera"Access webcam
"Microphone"Access microphone
"Logging"Access overwolf.log API
"Extensions"Run or get information about other apps
"Streaming"Enable game streaming
"DesktopStreaming"Enable desktop streaming
"Profile"Access profile information and perform actions such as login and modifications
"Clipboard"Access clipboard
"Hotkeys"Get hotkey information for the current app
"Media"Access media library
"GameInfo"Access current game information
"GameControl"Allows to send key strokes to the game by using overwolf.utils.sendKeyStroke()
"FileSystem"Allows accessing files from the local file system.
Note: This is the only permission we currently enforce
"LogitechLed"Allows accessing overwolf.logitech.led API
"LogitechArx"Allows accessing overwolf.logitech.arx API
"VideoCaptureSettings"Appear as a video capture extension in the capture settings + allows setting video capture settings
"Web"access to the overwolf.web API
"Tray"Access to creating tray icons

Meta object

Includes app metadata:

NameTypeDescriptionSince
namestringMandatory. Name of your app. See note.0.78
authorstringMandatory. The app's developer. See note.0.78
versionstringMandatory. Up to four dot-separated integers identifying the current app version.
Needs to be in the format of X.X.X where the X’s are numbers.
Here are some examples of valid versions:
["version": "1", "version": "1.0", "version": "2.11.3", "version": "4.1.2.345"]
0.78
minimum-overwolf-versionstringMandatory. Minimum version of the Overwolf Client with which the app is compatible. The format is similar to the "version" field. Make sure to set a version that is completly released to all the users. Otherwise, users will get the updated version but will not be able to launch it.0.78
minimum-gep-versionstringMinimum version of the Overwolf Game Events Provider with which the app is compatible. The format is similar to the "version" field.0.134
descriptionstringMandatory. Your app's description in the Appstore tile. Limited to 180 characters.0.78
dock_button_titlestringShort name of your app. Provide a short title that will fit in the dock button area – 18 chars max0.79
author_displaystringAn author name override to display instead of the actual author name. See note.0.78
iconstringMandatory. A relative path from the app folder to the icon’s png file. This is the mouse-over (multi-colored) version of the icon that will be displayed on the Overwolf dock. The icon dimensions should be 256×256 pixels, 72 PPI. Overwolf will resize it to 37×37. Please make sure the png is smaller than 30KB. More details on app icons can be found here.0.78
icon_graystringA relative path from the app folder to the icon’s png file. This grayscale version of the icon is for the default state that will be displayed on the Overwolf dock. The icon dimensions should be 256×256 pixels, 72 PPI. Overwolf will resize it to 37×37. Please make sure the png is smaller than 30KB0.78
launcher_iconstringA relative path from the app folder to the desktop shortcut icon’s ico file. This is a colored icon for the app’s desktop shortcut. More info here.0.78
tray_iconstringA relative path from the app folder to tray icon's ico file. This is the icon that will be used for the app in the tray. Defaults to launcher_icon if it is not defined0.201
splash_imagestringA relative path from the app folder to the splash image icon’s png file. The image size should be 256x256px. If this image is missing, Overwolf will use the “icon” image as a splash image0.116
window_iconstringA relative path from the app folder to the icon’s png file. This is the window task bar icon \ window header. The icon dimensions should be 256x256 pixels.0.116
important
Each app has a unique id (UID) that is generated out of the “name” and “author” strings. Once an app is published on the Appstore, its UID can’t be changed, so please choose your app and author names wisely before [submitting](/start/submit-app-proposal) your app. However, if absolutely necessary, it is possible to hide the original author name using `author_display`!

Webapp settings object

A list of additional settings for the app.

NameTypeDescriptionSince
game_targetingGameTargeting ObjectAn app can declare itself as targeted for one game or more.0.78
start_windowstringMandatory. The name of the window (from the “windows” list) to initially load when the app starts.0.78
enable_top_isolationboolEnable iframe isolation: runs it in a different process, so if some iframe is misbehaving (e.g. memory leak, etc.) it won’t crash your app and will only crash the iframe process.
useful with Overwolf ads that run in an iframe.
Default value is true
0.110
windowsextension_window_data ObjectMandatory. A map from window names to window settings.0.78
enable_top_isolated_sites_consoleboolEnable/Disable printing of ads log to the console.
Default value is “false”.
0.115
externally_connectableExternallyConnectable ObjectA definition of external URLs the web app should be able to access. Allow your local app to be able to communicate with an iframe within the app.0.78
protocol_override_domainsProtocolOverrideDomains ObjectOverrides the relative protocol with a preferred one.0.78
force_browserstringChoose whether links in the app will be opened using the user’s default browser or Overwolf’s browser.
Possible values: "user" or "overwolf".
0.91
enable_osr_accelerationboolEnable OSR/GPU acceleration if supported by this machine.
Note 1: The OSR acceleration feature is no longer supported and maintained.
Note 2: This flag is only relevant for D3D11 supported games.
Note 3: see also the optimize_accelerate_rendering flag.
0.126
game_eventsgame_events[]A list of game ids for which game events are required.0.92
disable_log_limitboolDisable the log file's 1000-line limitation.
Note: Do not enable it without Overwolf's approval.
0.12
extra-objectsextra-objects ObjectAllows access to custom plugin dlls.0.81
hotkeyshotkeys ObjectShortcut keys that trigger an app action.0.78
content_scriptscontent_scripts[]A list of content scripts to be loaded for specific windows.0.78
launch_eventslaunch_event_settings[]A list of events causing the app to launch.0.82
user_agentstringA custom user agent for the app to use when creating http requests.
Please read our notes
0.86
disable_dtboolDisable opening of the developer tools for the app (with Ctrl+shift+I).
Default value – “false”
0.118
service_providersservice_providers objectExtra data to external service providers0.137
developerdeveloper setting objectAdditional setting for developers.0.127
disable_cleanupboolIf set to true, app localStorage data will not be cleaned up after app uninstallation.0.147
process_namestringOverrides the default (OverwolfBrowser.exe) process name in task manager.
Please read our notes
0.153
max_rotation_log_filesnumberIncrease the app's log file rotation (defaults to 10, max is 40).0.154
url_protocolurl_protocol objectAbility to open an application from a browser using a link.0.158
uninstall_windowuninstall_window objecttriggers the client to run a window on app uninstall for a required time set.
Use it for running uninstall background actions like removing DLLs, logs, images, and other files injected by the app to the user's machine.
0.187
auto_relaunch_on_crashboolCauses apps to automatically relaunch if their process has crashed. if the app crashes 5 times consecutively, it will stop trying to relaunch.0.191
open_dev_toolsboolUsed for debugging. Automatically opens the dev tools window when opening an app window. *Note: it's possible to set this behavior on a per window basis if by adding this property to a specific window in the Window object0.191

user_agent Notes

  • Don’t use this property if your app serves ads. In case you have to use it, consult with us before.

  • using ‘navigator.userAgent’ will not return the custom user agent, but the default one.

process_name Notes

  • By adding a custom "process_name", the deafult OverwolfBrowser.exe process name (shown in the task manager) is overridden.

Note that The flag only affects external processes running, not ones that interact directly with the game. Also, the process will still have Overwolf's signature.

GameTargeting object

An app can declare itself as targeted to one or more games (or to all supported games).

NameTypeDescriptionSince
typestring"all" – All games (e.g voice communication apps).
"dedicated" – Dedicated to a game or several games.
"none" – No games.
0.78
game_idsgame_ids[]The game IDs that your app targeted and permitted to display in-game overlay windows on them.0.78

Example code:

"game_targeting": {
"type": "all" / "none" / "dedicated",
"game_ids": [5426, 7764] // only if type === "dedicated", wildcard not supported
}
important

In addition to this flag, don't forget to also set the game_events array, which defines from which games it can consume real-time game events.

extension_window_data object

A list of settings for the app windows.

NameTypeDescriptionSince
filestringMandatory. Points to a local HTML file to be loaded inside the window. If you wish to host your app in a remote web-site, you’ll have to have a local page that redirects to that remote website. In such cases, you need to make sure that the block_top_window_navigation property is set to false.0.78
show_in_taskbarboolDefine if the window is displayed in the Windows taskbar and alt-tab window selection menu.0.78
transparentboolIndicates whether the window will be transparent and borderless. Any part of your window with transparent background ("background: transparent;") will become a see-through area that blends with the game or desktop.
If set to false a standard Overwolf window will be created.
0.78
override_on_updateboolIndicates whether the window’s locally saved data should be overridden when the window’s size/location/opacity changes after a version update.0.119
resizableboolIndicates whether the window can be resized.0.78
show_minimizeboolIndicates whether to show the window minimize button. Only relevant when not in transparent mode.0.79
clickthroughboolIndicates whether the window will not receive clicks in-game, instead, the clicks will be passed on to the game.0.80
stylestringMouse and keyboard input will pass to the window AND to the game (no input blocking). InputPassThrough is currently the only possible value, You can set this flag also using the overwolf.windows.setWindowStyle().0.174
disable_rightclickboolWhen set to true, disable right clicks entirely for this window.0.92
forcecaptureboolIndicates whether this window should always be included in recordings, overriding any other setting.0.78
show_only_on_streamboolIndicates whether this window is visible only in streams (not visible to the streamer), overriding any other setting.0.78
ignore_keyboard_eventsboolIndicates whether the window will receive keyboard events or pass them on to the game.0.83
in_game_onlyboolMarks the window as available in-game only (Not accessible on Desktop).0.78
desktop_onlyboolMark the window as available on desktop only, and not in-game. This flag should be used (set to “true”) when “use_os_windowing” or “native_window” flags are set to true.
Note: using “desktop_only” and “native_window” flags for desktop windows will dramatically improve your app’s performance.
0.89
disable_restore_animationboolIndicates whether the window will animate on minimize/restore while in game.0.89
grab_keyboard_focusboolIndicates whether the in-game window will 'steal' the keyboard focus automatically from the game when it opens, or leave the keyboard focus untouched.
Default value is false
0.82
grab_focus_on_desktopboolIndicates whether the desktop window will grab the focus automatically when it opens, or leave the focus untouched.
Default value is true
0.99
sizesize objectDefines the size of the window in pixels when it is first opened. If your window is not resizable, this will be the constant size of your window. However, if your app is resizable – the app size is saved by Overwolf when closed so that the next time it is opened, it will preserve it. See our window sizes tips0.78
min_sizesize objectDefines the minimum size of the window in pixels. Default value is 100x100 pixels. If you want a window smaller than that, set this property to 0,0.
See our window sizes tips
0.78
max_sizesize objectDefines the maximum size of the window in pixels. See our window sizes tips0.78
start_positionpoint objectThe default starting position of the window counted in pixels from the top left corner of the screen.0.78
topmostboolIndicates whether the window will be on top of other Overwolf windows. Handle with care as topmost windows can negatively impact user experience.0.89
bottommostboolIndicates whether the window will be on bottom of other Overwolf windows. Handle with care as bottommost windows can negatively impact user experience.0.180
block_top_window_navigationboolRefrain from non "target=_blank" html elements from “taking-over” the entire app’s window0.100
keep_window_locationboolWindow location won’t be changed when game focus is changed0.101
use_os_windowingboolWhen set to true, allows your window to have a full-screen maximize when calling the overwolf.windows.maximize function, and a real taskbar minimize when calling overwolf.windows.minimize.
Note: Should only be used with desktop_only windows
0.102
background_optimizationboolEnables JS engine background optimization.
Default value is true
0.103
muteboolMutes sounds in window0.102
mute_excluded_hostsstring[]Excludes hosts list so a stream from these hosts origins will not get muted even if the window is on "mute": true0.103
popup_blockerboolPrevents new browser windows being opened automatically using script.
Default value is false
0.103
show_maximizeboolEnables window maximize button. Relevant only for the standard Overwolf window ("transparent": false)
Default value is false
0.106
disable_blurboolCauses the app’s window to never “lose focus”, so the window.onblur event is never triggered.
Default value is false
0.106
native_windowboolCreates a native CEF desktop only window (which improves performance)
Note: Should only be used with desktop_only windows.
Default value is false
0.107
is_background_pageboolThis flag MUST be used with background/hidden controller windows.
Note: With this flag set to 'true', there's no need to set window related properties such as size, focus, transparency, etc.
0.107
focus_game_takeoverstringAllows you to control the behavior of an app window while in a “mouse-less” game state.
Possible values: "ReleaseOnHidden" or "ReleaseOnLostFocus". Read notes.
0.107
focus_game_takeover_release_hotkeystringAllow Overwolf to display your app’s hotkey combination on the screen when the user switches to “exclusive mode”.
The string value should be the hotkey name from the hotkeys section.
Relevant only if you set focus_game_takeover=ReleaseOnHidden
0.110
allow_local_file_accessboolAllows access to local files that are not located in your app’s (extension) folder.
Default value is false
0.109
is_alt_f4_blockedboolBlocks the user from closing the window by using Alt+F4.
You can register to the onAltF4Blocked event to be noticed when a “block” was triggered.
0.113
dev_tools_window_styleboolOpens developer tools in dedicated window.0.117
debug_urlstringFor local-server debugging (like react apps). You can use this field to set the localhost:port URL.
Notes: You must have a local web server installed on your machine.
Valid only when loading unpacked extensions.
Valid only with "localhost" / "127.0.0.1".
When using this flag the OW object is only available in the background window
0.127
optimize_accelerate_renderingboolValid only for transparent windows. Valid only if enable_osr_acceleration is on.0.127
disable_auto_dpi_sizingboolRelevant only for native windows. Disable the DPI Aware behavior of native windows. overwolf.windows.changeSize() can Overwrite this flag in runtime.0.148
restrict_to_game_boundsboolA window will always stay inside the game window while dragging.0.158
disable_hardware_accelerationboolDisable GPU hardware acceleration, per window. Relevant only to native windows.
Notes: Use this flag mainly for native windows that run as a second-screen with fps intensive games. It improves the performance of the game by reducing usage of the GPU while you are playing.
0.159
open_dev_toolsboolUsed for debugging. Automatically opens the dev tools window when opening the app window0.191

ExternallyConnectable object

A definition of external URLs the web app should be able to access. Read more here.

Using "externally_connectable" will allow your local app to be able to communicate with an iframe within the app (via postMessage).

In addition, adding externally_connectable to your app allows you to send HTTP/S requests (e.g., fetch data using XmlHttpRequest) to the defined URL's and get a response without getting a CORS violation error.

NameTypeDescriptionSince
matchesstring[]Array of web page URL patterns to match with an external server URL0.78

Notes:

  • Use star (*) in place of subdomain to allow access to all subdomains
  • Make sure that the end of URL is WITHOUT any slash/backslash

Example code:

"externally_connectable": {
"matches": [
"http://*.mysite.com", //make sure that the end of URL is WITHOUT any slash/backslash
"https://*.mysecuredsite.com",
"my-protocol://"
]
}

ProtocolOverrideDomains object

Overwolf apps run under a custom url protocol and domain (overwolf-extension://[app-id]). This means that protocol-relative urls (//ajax.googleapis.com…) will try to load from a the overwolf-app protocol. Unless you want this to happen, you can use protocol_override_domains to override the relative protocol with a preferred one (e.g. https/http).

NameTypeDescriptionSince
protocol_override_domainsstringweb page URL patterns to override.0.78

Example code:

"protocol_override_domains" : {"ajax.googleapis.com": "https", "domain.com": "http"}

This will swap the overwolf-app protocol with https for ajax.googleapis.com domain requests and with http for domain.com requests.

game_ids array

A list of game ids for which game events are required. The full list of games that Overwolf supports real time event listening can be found here.

NameTypeDescriptionSince
game_idsint[]The games IDs that your app targets.0.92

Example code:

"game_ids": [7764, 5426, 7314]

game_events array

A list of game ids for which game events are required. The full list of games that Overwolf supports real time event listening can be found here.

NameTypeDescriptionSince
game_eventsint[]The games IDs that your app targets.0.92

Note: this array is exactly the same as the game_ids[], and we use it only for backwards compatibility.

Example code:

"game_events": [7764, 5426, 7314]
important
  • Wildcards are not supported- even if your game is targeted to all games, you should specify all the relevant game ids.
  • In addition to this flag, don't forget to set the GameTargeting object, which configures the overlay permissions.

extra-objects object

Allows the access of custom plugin dlls. For more info see https://github.com/overwolf/overwolf-plugins.

NameTypeDescriptionSince
filestringthe relative file path for the custom plugin dll.0.81
classstringthe namespace entry point for the custom plugin dll.0.81

Example code:

"extra-objects":{
"my-plugin":{
"file":"plugins/my_plugin.dll",
"class":"MyPlugin.EntryPoint"
},
"simple-io-plugin":{
"file":"plugins/simple-io-plugin.dll",
"class":"overwolf.plugins.simpleio.SimpleIOPlugin"
}
}

Then, from your app you can use the overwolf.extensions.current API to get an instance:

overwolf.extensions.current.getExtraObject(“simple-io-plugin”, function)

hotKeys object

HotKeys are shortcut keystrokes that trigger app actions. The most common, basic usage is to show and hide your app in-game, but you can trigger more actions like saving, refreshing or any other custom actions.

Please read all the info about hotkeys and how to use them in our hotkeys best practice guide.

The map between the hotkey feature name and its settings:

NameTypeDescriptionSince
titlestringMandatory. Name of the hotkey as it will appear in the Hotkey tab in the settings.0.78
action-typeenumDefines the behavior of the hotkey: ["toggle", "custom"]0.78
defaultstringThe default key combination.0.78
passthroughboolThe hotkey will not block keys from the game.0.78
holdboolDefines whether this hotkey is meant to invoke an action while being held.0.142

Example code:

"hotkeys": {
"show_YourAppName": {
"title": "Show Player",
"action-type": "custom",
"default": "Shift+F9",
"passthrough": true,
"hold": true
},
"save_YourAppName": {
"title": "Save Replay for later",
"action-type": "custom",
"default": "Ctrl+Shift+F9"
}
}

content_scripts Array

A list of content scripts to be loaded for specific windows.

NameTypeDescriptionSince
windowsstring[]The list of windows for which to apply this content script.0.78
matchesstring[]The list of URLs for which to apply this content script. (regex supported)0.78
cssstring[]The list of CSS files to be applied in this content script.0.78
jsstring[]The list of JS files to be applied in this content script.0.78

In this example, when loading the index window, myscript.js will be loaded and when encountering https://google.com, mystyles.css and myscript2.js will be loaded:

"content_scripts": [
{ "windows": [ "index" ], "js": [ "myscript.js" ] },
{ "matches": [ "https://google.com/" ], "css": [ "mystyles.css" ], "js": [ "myscript2.js" ] }
]

Note: it also work for any iframes the app is hosting in an Overwolf window (not just the main page).

launch_event_settings array

A list of events causing the app to launch. It's enough that one of the events occurs to launch the app.

NameTypeDescriptionSince
eventenumThe type name of the event.
["GameLaunch", "AllGamesLaunch", "LaunchWithOverwolf"]
0.82
event_datalaunch_event objectThe list of game class IDs for which the app will launch.0.82
include_launchersboolThe app will be launched when any game launcher is detected (Requires "AllGamesLaunch" to work).0.103
trackedboolLaunch App when gameid is detected (even when not injected). Only works for supported launchers.0.132
track_all_gamesboolOnly applicable when the 'tracked' property is set to true. Launches the app for all instances defined in the Gameslist, even those who are defined as "Unsuppported".0.195
start_minimizedboolThe app’s main window will start minimized.0.82

Code Example:

"launch_events": [
{
"event": "GameLaunch",
"tracked": false,
"event_data": {
"game_ids": [1136],
"wait_for_stable_framerate": 30
},
"start_minimized": true
}
]

Enable app auto-launch with Overwolf

You can launch your app when a certain event occurs, by setting event to these values:

  • When the OW client launches: "LaunchWithOverwolf".
  • When a listed game launches: "GameLaunch".
  • When any game launches: "AllGamesLaunch".

By setting include_launchers to true, the app will also launch if it detects a launcher while having AllGamesLaunch as the event property. Launchers can still be detected without this flag, using their direct app id

If the app would have been launched by any of these behaviours, but it is already open, [onAppLaunchTriggered](overwolf-extensions#onapplaunchtriggered] is fired.

Notes:

Code example:

"launch_events": [
{
"event": "LaunchWithOverwolf" // The event is fired when Overwolf starts.
}
]

launch_event object

Contains a list of game class IDs for which the app will launch.

NameTypeDescriptionSince
game_idsint[]The list of game class IDs for which the app will launch.0.82
wait_for_stable_framerateintThe app won’t start until the game’s framerate will stabilize around or above the stated framerate.0.82

Code Example:

 "event_data": {
"game_ids": [1136],
"wait_for_stable_framerate": 30
}

developer settings object

Additional setting for helping apps developers. Mainly to set auto reloading of an app when local files changes.

Note

These settings are relevant only if your app is in dev mode (channel="developers"), or if you are loading it as an unpacked folder.

NameTypeDescriptionSince
enable_auto_refreshboolEnable auto App reloading when detecting files changes.
default is true
0.127
reload_delayintDelay in milliseconds. When detecting file changes (for multiple changes).
default value is 1000 milliseconds (1 second)
0.127
filterstringFilter files which will be tracked.e.g (.js;.html.
default value is “.” -> all files, but you can use several value like “.json;.html”
0.127

Code Example:

"developer": {
"enable_auto_refresh": true,
"reload_delay": 1000,
"filter": "*.json;*.html"
}

service_providers object

Provide extra data to external service providers. External apps (AKA service providers) can fetch this data from your app's manifest.

This object can contain any valid JSON objects, as long as it wrapped with the hosting app UID.

Code Example:

"service_providers": {
"nafihghfcpikebhfhdhljejkcifgbdahdhngepfb": { //hosting app UID, Mandatory. On this case, it's the Game Summary built-in app UID.
"whatever": "value"
}
}

size Object

Defines a size (width and height) in pixels.

NameTypeDescriptionSince
widthintDefines the width in pixels. Optional parameter0.78
heightintDefines the height in pixels. Optional parameter0.78

point Object

Defines a top-left position in pixels.

NameTypeDescriptionSince
topintDefines the position in the Y axis from the top in pixels. Optional parameter0.78
leftintDefines the position in the X axis from the left in pixels. Optional parameter0.78

focus_game_takeover options

In games such as Overwatch and World of Tanks, which have a state without a mouse cursor, the user can’t control the Overwolf app window. This flag automatically sets the app window into "exclusive mode" – input don’t pass to the game, and a cursor is available.

Note that some of the games (e.g CS:GO) can run in "trusted mode," which disable the "exclusive mode" in the game and makes it impossible to interact with your OW app window.

You can defines how the “exclusive mode” should be turned off:

  • ReleaseOnHidden – When the window is hidden, automatically turn off exclusive mode. (if you are using this option, you must set also the focus_game_takeover_release_hotkey flag)
  • ReleaseOnLostFocus – If the user clicks outside the window, exclusive mode is turned off.

Read more in our Exclusive Mode guide.

url_protocol object

Ability to open an application from a browser using a link.

Add your custom data protocol under "url_protocol" (for example, outplayed://something/null) to create a link to your app.

You can use this link on a webpage or OW app to open your OW app. It will open your OW app, with an option to send some additional data to your app.

NameTypeDescriptionSince
schemestringMandatory. The custom data URL protocol scheme.0.158

Example data:

{"scheme": "outplayed"}
  • For a closed app, a click on a custom link launches the app.
  • For a closed OW client, a click on a custom link launches OW + the app.
  • For an open app, a click on a custom link opens the app and fire the onAppLaunchTriggered event with a "urlscheme" origin.

If an extra params has been sent (e.g. "outplayed://something/null"), the onAppLaunchTriggered event callback will show them under the "parameter" field:

{origin: "urlscheme", parameter: "outplayed%3a%2f%2fsomething%null"}

uninstall_window object

This manifest flag triggers the client to run a window on app uninstall for a required time set. Use it for running uninstall background actions like removing DLLs, logs, images, and other files injected by the app to the user's machine. You can also use it for showing an uninstall survey (in the user's default browser).

  • If it exists, the client will run this window in the background for the required time (or 10 seconds by default. Valid up to 1 minute) before actually uninstalling an app.
  • When the flag is set, the Overwolf client will run this window in the background right BEFORE the app is removed.
  • If the Overwolf client is uninstalled, the uninstaller will let the client run all uninstall windows before actually uninstalling overwolf.
important

The uninstall window is running in the background, you shouldn't open any Overwolf app window while it's running. You can open the user's default browser (for uninstall survey for example).

NameTypeDescriptionSince
filestringPoints to a local HTML file to be loaded inside the window0.187
required_runtimeintValid up to 60000 (1 minute).
default value is 10000 milliseconds (10 seconds)
0.187

Code Example:

"uninstall_window": {
"file": "name.html",
"required_runtime": 20000
}