Skip to main content
Overlayed provides two update systems: App updates (the Electron app) and Site updates (your frontend).

App Updates

The overlayed.updater module provides methods to check for updates, switch channels, and install updates.

Checking for Updates

Listening to Update Events

Installing Updates

After an update is downloaded, you can install it:
Alternatively, you can wait for the checkForUpdates promise to resolve:
quitAndInstall will throw an error if canUpdate() returns false. This happens when the user is currently in a game.

Private Channels

For private update channels, you must provide an access token fetcher:
Listen for token invalidation when they lose access and move them to the public channel:
See Private Channels for full server implementation examples.

Switching Channels

To switch update channels (e.g., from stable to beta):

Site Updates

The overlayed.updater.site module handles Site updates separately from App updates.

Automatic Updates (Default)

By default, Site updates are applied automatically. When you deploy a new Site version, users will receive it on the next call of BrowserWindow#loadURL.

Manual Updates

To control when Site updates are applied, enable manual updates:
Then listen for new versions and prompt users:

Application Info

The overlayed.application module provides information about the current release:
We recommend showing the channel and version in your UI to help users give better feedback and bug reports.

Update Events Reference