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.

Each overlay must define an overlayed.config.ts file in the root of the project. This file is used for various reasons like helping our cli know how to bundle your overlay.

Example

import { defineConfig } from "@overlayed/app";

export default defineConfig({
	applicationId: "YOUR_APPLICATION_ID", // Application ID from the Overlayed Dashboard
	app: {
		include: ["dist-electron/**/*"],
	},
	site: {
		include: ["dist-site/**/*"],
	},
});

More Info

You can find more information about the config file and all the options available here.