Skip to main content

​
Creating a Window

Create out of game windows with the following:
This will return an electron BrowserWindow.
You must create every out of game window with this method so that Overlayed can keep track of them.
Every window created this way is automatically protected against navigation takeovers (e.g. malicious ad creatives) — see Navigation Guard for the policy and how to customize it.

​
In-game Windows

To render a window in-game, you’ll need to do the following:
This will return a RenderWindow, read more about them in-depth here.
If you want to render the same window in-game and out-of-game, you’ll need to create the window twice, once with createInGameWindow and once with createWindow.

​
Active Game Info

The getActiveGameInfo method returns useful information like if the overlay is connected to the game, the game’s resolution, etc.

​
Production Site URL

Get the production site URL configured in your Overlayed Dashboard:
This is useful for loading your deployed frontend in production while using a local dev server during development.