SeverityWhat it means
fatalSomething has gone fatally wrong with the app, and you need to act on it.
errorAn error has occured within the app, that may require you to act on it.
warningA warning has occured within the app, you likely dont need to listen to these

Listening to Issues

You can listen to these issues anywhere in your code directly on the overlayed object

overlay.on("fatal", (event) => {
	if (event.code === "ELEVATION_MISMATCH") {
		// Alert the user that the game and app must be on the same level of windows priveleges
	}
});

Fatal Issue List

CodeDescriptionData
ELEVATION_MISMATCHThe game was launched with Admin mode, but the overlay was not, so therefore the overlay cannot do the actions it requires.appElevated:boolean
gameElevated:boolean

Error Issue List

CodeDescriptionData
PIPE_SERVER_ERRORAn error occured with the communication between the overlay and the game.error:unknown
INVALID_CONFIG_FILEA configuration file that the overlay manages was set incorrectly. An example of this is the keybinds. If you’re using Typescript, it’s unlikely you’ll run into this since types will validate what you set.issues:string[]
filePath:string
data:unknown

Warning Issue List

CodeDescriptionData
INVALID_EVENTThe overlay received an invalid game event. It would be useful for you to log this, and if a user is experiencing weird app behavior, to forward those logs to us.summary:string