Skip to main content

Per-game settings

Overview​

The Overwolf platform enables users to control each app's permissions separately. This gives granular control over opening windows and auto-launching app features. Users can also disable the in-game overlay for each app or for all apps of a specific game if they prefer it.

Whenever permissions or overlay settings are changed, Overwolf informs users through notifications and messages. Keeping users informed is important for good user experience.

This level of control provides:

  • Apps that are non-intrusive.
  • Clear messaging about pending changes.
  • The best tools to optimize users’ Overwolf gaming experiences that match their preferences.

Recommendations for app developers:

  • Inform users about expected app behavior changes in advance.
  • Let users manage how your app works when launched as well as both in and out of game.
  • Improve your on-boarding process and clearly explain how the app will work in-game.
  • Build a settings page in which the user can change how the platform, app, or game behave in Overwolf.
  • Notify your users whenever permissions or functionality change.

Terminology​

  • Overwolf Game Settings—the Games section of Overwolf's client settings.
  • Auto Launch—an app’s ability to launch itself according to internal logic, once triggered by Overwolf.
  • Auto Launch Permission—platform level permission that allows the activation of an app’s logic that triggers auto launch.
  • Permission—after installing an app, if parts of the overlay aren't enabled, users will get a notification asking for overlay permissions.
  • Dedicated app—an app which is intended to be used in a specific game, and declared as such in the manifest (for example, LoLwiz for LoL).
  • Multi app—an app which is intended to be used in a number of supported games, and declared as such in the manifest (for example, Killer Voices).
  • Global app—an app which is intended to be used in ANY game, and declared as such in the manifest (for example, TeamSpeak).
  • Game Settings API—the API by which an app may query the status of Overlay and Auto Launch Permission settings per game.
  • Overlay—the ability to display Overwolf components and apps in-game.

Overwolf settings​

  • When overlay permissions for a game are disabled, no Overwolf apps or features will be displayed inside this game.
  • Apps may, or may not, have an Auto Launch capability.
    • Auto Launch has to be stated in the manifest.
    • Auto Launch Permission per app is the platform’s way to allow or disallow app auto launch in-game.
    • A user may launch the app manually from the dock, desktop or any other way regardless of auto launch permission state.
    • Apps without auto launch capability will not have a permission checkbox at all.

Using the API​

Every app can use the Game Settings API to query the status of Overwolf's settings PER GAME including:

Bring more value​

App notifications should inform its users if:

  • Overlay for the supported game is disabled, users will not be able to use the app in-game.
  • Auto Launch Permission is unchecked, the app will NOT auto launch when the game begins. However it can be manually launched.
  • In some apps manual launch may result in lack of functionality.

In cases of a Multi or Global apps, it's important to inform users if there are specific games in which these apps or parts of their functionality will not work as expected.

When informing the users about permission or overlay settings, suggest a fix and call users to action. Use a link that launches the Game Settings window where users can enable missing permissions. Put the link in a prime location where users will see it and its easy to find.

Make sure that apps cannot change settings through API by themselves, and that the user has control and can change these settings.