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

# OverlayedConfig

> The configuration for the overlayed.config.ts file

## Usage

```ts theme={null}
import { defineConfig } from "@overlayed/app";

export default defineConfig({
	// ...
});
```

The following properties are available on the `OverlayedConfig` interface.

## applicationId

Your Overlayed application ID.

* **Type**

  ```typescript theme={null}
  applicationId: string;
  ```

## app

The bundle config for your Electron app.

* **Type**

  ```typescript theme={null}
  app: BundleAppConfig;
  ```

## site

The optional bundle config for your site.

* **Type**

  ```typescript theme={null}
  site?: BundleSiteConfig;
  ```

## bundle config

Shared fields for both `BundleAppConfig` and `BundleSiteConfig`.

* **Type**

  ```typescript theme={null}
  interface BundleConfigBase {
  	/**
  	 * The base directory to bundle from.
  	 *
  	 * @default location of the overlayed.config.ts file
  	 */
  	baseDir?: string;
  	/**
  	 * String or array of string glob patterns to bundle.
  	 *
  	 * `package.json` is always included.
  	 */
  	include: MaybeArray<string>;
  	/**
  	 * String or array of string glob patterns to exclude from the bundle.
  	 *
  	 * `/installer` is always excluded.
  	 */
  	exclude?: string | string[];
  }

  interface BundleAppConfig extends BundleConfigBase {}
  interface BundleSiteConfig extends BundleConfigBase {}
  ```

* **Details**
  * `baseDir` (optional): The base directory to bundle from. Defaults to the location of the `overlayed.config.ts`
    file.
  * `include` (required): String or array of string glob patterns to include in the bundle. `package.json` is always
    included.
  * `exclude` (optional): String or array of string glob patterns to exclude from the bundle. `/installer` is always
    excluded.

## debug

When true, the bundle will be created in debug mode.

* Extra logs will occur

* The bundles will be outputted as a zip instead of uploading to the Overlayed platform

* **Type**

  ```typescript theme={null}
  debug?: boolean;
  ```

* **Default:** `false`