Skip to main content

Developing Overwolf Electron Apps on Mac or Linux Platforms

Java script and Typescript are supported on many platforms and you can setup your development environment on any Windows, Mac, or Linux based operating system. In order to thoroughly test your app, you will need to run a virtual machine (VM) with Windows, to ensure that your application runs correctly in a native Windows environment. Using a VM enables you to simulate app scenarios such as in-game overlays, hotkey handling, and injection behavior.

important

The Overwolf client and Overwolf Electron apps will only run on Windows based systems.

Currently only ad services are supported for Mac and Linux. Overwolf services such as overlay, game events, and recording are currently in development.

note

All Overwolf Electron apps will need to follow the same onboarding procedure regardless of the operating system they were developed on. For more information, see the Onboarding Journey.

Prerequisites​

  1. Development tools—use your favorite development tools or an IDE (e.g., VSCode) to write and manage your JavaScript or TypeScript files. You may not be able to use the built in debugging tools for Overwolf Electron apps developed on non-Windows based operating systems.
  2. Virtual Machine software for running Windows—essential to simulate a native Windows environment, especially for testing Overwolf specific functionality such as game overlays, game events, and hotkeys. In order to ensure compatability, you will need GPU passthrough to mimic actual in-game behavior. (e.g., VM with GPU passthrough - QEMU/KVM, with GPU passthrough).
  3. Windows OS ISO image—a valid ISO file to install Windows on the virtual machine which serves as your runtime environment for testing and validating your app.

Setting up the dev environment​

  1. Install your development tool. Overwolf recommends that you use VSCode.
  2. Install your virtual machine software. Then, create a VM and install Windows, and setup the GPU passthrough.
  3. Setup your development environment on your non-windows operating system. For more information, the list of Prerequisites.

Developing your app​

To start developing your app, follow the procedures for Building your first app.

Running and testing your app​

In order to test your app you will need to run it in the Windows VM that you installed. Ensure that your VM has internet connectivity in order to test the full functionality of your app.