Overlay Events

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

Game Launch

Runs right when the game’s process is created.

• To listen to a game launch, you must enable universal mode in your configuration.
• Alternatively, the overlay will only emit launch events for modules passed to configuration.

overlay.on("gameLaunch", ({ game, reject }) => {
	// ...
});

You can reject the game launch from being handled by the overlay by calling reject():

overlay.on("gameLaunch", ({ game, reject }) => {
	if (game === "valorant") {
		reject();
		return;
	}

	// ...
});

This is useful if you have a setting that disables your overlay for a given game.

Game Ready

Runs once the overlay is ready to render in-game.

overlay.on("gameReady", ({ game }) => {
	if (game === "siege") {
		// ...
	}
});

Game Closed

overlay.on("gameClose", ({ game }) => {
	if (game === "siege") {
		// ...
	}
});