Overwolf

Overwolf

  • Getting Started
  • Docs
  • API
  • Events Status
  • Blog
  • Q&A
  • Support

›Best Practices

Best Practices

  • Overview
  • App specific experience
  • First time user experience
  • App launch performance
  • Marketing Communications
  • User journey and error handling
  • Per-game settings
  • Hotkey best practices
  • Second monitor usage
  • Data persistence
  • Reduce OPK size
  • Use Tab as an app Hotkey
  • Type definition file
  • Download Link with referral ID
  • Video capture best practices
  • Enable Developer Tools
  • Exclusive Mode Overlay
  • Electron Migration

Using Windows API

  • Using Overwolf windows
  • Windows Communication
  • Windows Types
  • Resolution Size and Position
  • General Tips

Understanding OW logs

  • What are Overwolf logs
  • DxDiag log
  • Trace logs
  • OBS logs
  • OverwolfPerf log
  • Overlay game HTML

Using Plugins

  • Plugins overview
  • Plug-in Implementation
  • Write your own plugin
  • Sample plugin
  • Simple I/O plugin
  • TeamSpeak plugin
  • Downloader plugin
  • Process Manager plugin

Using Events

  • JavaScript events overview
  • Using game events in your app
  • Game events Simulator
  • Verifying event status

Developers Console

  • Submit a new version
  • Release notes
  • Submit for review
  • Update store listing
  • Manage your subscriptions
  • Users and permissions
  • Crash reports
  • Rating and reviews
  • App Channels
  • CLI

Integrations

  • Integrating app analytics
  • Login with Twitch
  • Login with Overwolf
  • Event SDK for Game Devs
  • Twitch Extensions

Request a Service

  • Marketing asset requirements
  • Looking for Group
  • Promoting your app
  • App recommendations

Community Help

  • Join the Community
  • Webinars
  • Developers Content
  • Code snippets

Legal

  • Legal overview
  • App terms
  • Developers terms
Edit

Porting your Electron app to Overwolf

In case you have an existing application on Electron, porting your app to Overwolf is very easy, and should take about a week of work for a single developer. This will allow you the best of both worlds while you maintain full control of your destiny. Like Electron, Overwolf is built on Chromium. While Electron is a generalized product - Overwolf is dedicated specifically for gaming apps.

Once you have a build on Overwolf, you’d be able to enjoy features like in-game overlay, real time telemetry, monetization, analytics, customized installer, auto updates, free CDN, marketing, signatures, and a lot more!

Our framework allows you to keep both versions live, with one code base and negligible live-ops overhead. At any given time, you can choose to deploy updates to Electron, Overwolf, or both. We did it ourselves to the CurseForge app, and we’re happy to explain how.

One code base for Electron and OW app

It is simple to maintain both Electron and Overwolf support for the app - basing it on the same codebase.

  • Core package/module with most of the app’s logic and UI
    • Abstracting Framework specific APIs (e.g. WindowsService [overwolf.windows, BrowserWindow], CommunicationsService [overwolf.windows.getMainWindow, Electron preload] etc...).
  • Thin package for Overwolf - uses core package.
  • Thin package for Electron - uses core package.
  • We can help build it for you! Reach out.

Recommended steps to keep both versions

These are the recommended steps to keep both versions:

  • Electron browser process code → Overwolf background controller
  • Electron renderer process code → Overwolf Window
  • Communication layer (preload code → overwolf.window.getMainWindow)
  • Abstracting framework specific code (Electron/Overwolf) and injecting the relevant implementation (e.g. Electron APIs vs Overwolf APIs, node.js vs .net plugins)
    • Here we can help with converting to .net
  • Once you get the technical part cover we suggest communicating with your users how the two clients differ from each other: added features, reducing cost, overlay etc
  • Lastly, if you’re not happy with our service - you can always easily go back to being exclusively on Electron. If you choose to go just on Overwolf, you can go back at any given time to Electron.

If you have any questions, please reach out.

Last updated on 7/13/2021 by ZeusLucis
← Exclusive Mode OverlayUsing Overwolf windows →
  • One code base for Electron and OW app
    • Recommended steps to keep both versions
  • 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
Overwolf 2022