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.

Installation

pnpm i @overlayed/electron --save-exact

Usage

Anytime you run the electron app, you’ll want to use ogg-electron instead of electron.
{
    "scripts": {
        "start": "ogg-electron ."
    }
}
You do NOT need to import anything from @overlayed/electron that you would normally import from electron. Continue to things like app and BrowserWindow as you normally would.