> ## 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.

# Getting Started

> A mandatory custom electron version for Overlayed apps

## Installation

<CodeGroup>
  ```bash pnpm theme={null}
  pnpm i @overlayed/electron --save-exact
  ```

  ```bash npm theme={null}
  npm i @overlayed/electron --save-exact
  ```

  ```bash yarn theme={null}
  yarn add @overlayed/electron --exact
  ```
</CodeGroup>

## Usage

Anytime you run the electron app, you'll want to use `ogg-electron` instead of `electron`.

<CodeGroup>
  ```json package.json (new) theme={null}
  {
      "scripts": {
          "start": "ogg-electron ."
      }
  }
  ```

  ```json package.json (old) theme={null}
  {
  	"scripts": {
  		"start": "electron ."
  	}
  }
  ```
</CodeGroup>

<Info>
  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.
</Info>