Installation

About

The core package for building Overlayed apps

Effortlessly build modern, performant game overlays.

Setup a new electron app to integrate with Overlayed in just a few minutes

Everything is developed with type-safety in mind, so we strongly recommend you also use Typescript to reap the benefits.

The main overlay object has a variety of events you can listen to on it

The Overlayed App will occasionally emit various levels of issues that you may want to listen to in order to handle certain scenarios.

Windows are a core part of overlays, this guide will cover various utilities we provide for managing them.

Keybinds allow your users to interact with your overlay via their keyboard.

An interface to granularly block mouse input or certain keys.

The options object passed into the `overlayed` function

A mandatory custom electron version for Overlayed apps

Below is a comprehensive list of all of the games that are supported by Overlayed.

All of the game events emitted by Rainbow Six Siege.