Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.overlayed.gg/llms.txt

Use this file to discover all available pages before exploring further.

overlayed.universal.readyForGameEvents() must be called before any events will be emitted.

logged_in

The user’s account ID for that particular game.
interface LoggedInEvent {
	account_id: string;
}

module_loaded

interface ModuleLoadedEvent {
	game_version: string;
	process_hash: string;
}

module_unloaded

interface ModuleUnloadedEvent {
}

unsupported_game_version

interface UnsupportedGameVersionEvent {
	game_version: string;
	process_hash: string;
}