ow-electron-packages-sample

A basic sample app, demonstrating how @overwolf/ow-electron packages (Overlay, Game Events) work.

For more details about ow-electron, as well as how to fully utilize it, please refer to the official documentation.

Setup

To set up this app, you must first install its dependencies (using yarn, npm, or any other package manager).

From there, you can easily run/interact with it.

Quick start

To run the app in development mode, simply run the build script, followed by the start script from the package.json.
For example:

# Using npm
npm run build
npm run start

# Using yarn
yarn build
yarn start

VSCode launch.json

This repository also includes a working .vscode/launch.json file, meaning that you can launch the app by simply clicking F5 on your keyboard (for default vscode settings).

Quick Build

To build the app for production, you must run the build script, followed by the build:ow-electron script from the package.json.
For example:

# Using npm
npm run build
npm run build:ow-electron

# Using yarn
yarn build
yarn build:ow-electron

Working with ow-electron packages

In order to add more/remove certain ow-electron "packages" from the project, simply edit the overwolf.packages array in the package.json file, like so:

{
  ...
  "overwolf": {
    "packages": [
      "gep",
      "overlay"
    ]
  },
  ...
}