In order to subscribe to events for a given game, you’ll need to use the game’s respective module. This helps with bundle sizes so you only load the event code that you need, and helps organize our architecture.

View our supported games and their events here.

​
Example

import { Siege } from "@overlayed/app/siege";
import { overlayed } from "@overlayed/app";

const overlay = overlayed({
	modules: [Siege.module()],
});

overlay.siege.on("player_joined", (event) => {
	// ...
});

​
Listening to any event

overlay.siege.onAny((event) => {
	// ...
});

​
Typed and Validated

All events are validated with Arktype and fully typed. This means you can be confident in the data you receive, and will never run into an event with a missing property or incorrect type.

We expose all of the types for each event on the module, for example:

import { Siege } from "@overlayed/app/siege";

type T = Siege.PlayerJoinedEvent;

​
Constants

We also expose helpful constants and other game data on the module, for example:

import { Siege } from "@overlayed/app/siege";

Siege.DAMAGE_TYPES; // ["bullet", "melee", "explosive", "falling", "regeneration", "unknown", "debris", "projectile", "downed", "gas", "thermal_explosion", "melee_gadget", "barbed_wire", "electric", "reinforcement", "frag", "paralyzed", "emp", "break", "cleanup", "interrogation", "melee-finisher", "toxic", "toxic-explosion", "pneumatic", "body-contact", "contact-explosion", "flash", "parasite-spike", "laser", "concussion", "blowtorch", "taser-shield", "reverse-friendly-fire", "self-destroyed", "area-control", "fire", "breach-kick", "break-wall", "blade-mine", "invalid"]
Siege.TEAMS; // [0, 1],
Siege.SIDES; // ["attacker", "defender", "both", "invalid"]