# Overlayed

## Docs

- [Overlay Ads Setup](https://docs.overlayed.gg/ads/ads-setup.md): Learn how to setup ad units in your overlay.
- [Overlay Ads Configuration](https://docs.overlayed.gg/ads/configuration.md): Learn how to configure various aspects of your ads.
- [Overlay Ads](https://docs.overlayed.gg/ads/introduction.md): Ads allow you to monetize your overlay, this guide will cover various utilities we provide for managing them.
- [Blocking Input](https://docs.overlayed.gg/advanced/blocking-input.md): An interface to granularly block mouse input or certain keys.
- [Delayed Initialization](https://docs.overlayed.gg/advanced/delayed-init.md): Delaying Overlayed's initialization.
- [Introduction](https://docs.overlayed.gg/deployment/introduction.md): How to deploy your Overlayed Application
- [Private Channels](https://docs.overlayed.gg/deployment/private-channels.md): Implementing authentication for private update channels
- [Updates](https://docs.overlayed.gg/deployment/updates.md): Managing App and Site updates in your overlay
- [App Structure](https://docs.overlayed.gg/essentials/app-structure.md): Understanding the architecture of an Overlayed app
- [Game Events](https://docs.overlayed.gg/essentials/game-events.md): A guide to subscribing to game events.
- [App Issue Handling](https://docs.overlayed.gg/essentials/issue-handling.md): The Overlayed App emits various levels of issues that you may want to listen to in order to handle certain scenarios.
- [Local Development](https://docs.overlayed.gg/essentials/local-development.md): Setting up your local development environment for Overlayed
- [Overlay Events](https://docs.overlayed.gg/essentials/overlay-events.md): The main overlay object has a variety of events you can listen to on it
- [Overlayed Config](https://docs.overlayed.gg/essentials/overlayed-config.md): Setting up the overlayed.config.ts file
- [Security](https://docs.overlayed.gg/essentials/security.md): Important information for keeping your application secure and preventing abuse.
- [Event & Log Tracking](https://docs.overlayed.gg/event-tracking/introduction.md): Overlayed provides first class support for tracking events and logs from your application through the Cortex module.
- [Model Context Protocol](https://docs.overlayed.gg/extras/mcp.md): Connect Overlayed documentation to your AI tools
- [Feature Flags](https://docs.overlayed.gg/feature-flags/introduction.md): Remotely toggle features in your overlay using the Overlayed Dashboard.
- [List of Supported Games](https://docs.overlayed.gg/games/introduction.md): Below is a comprehensive list of all of the games that are supported by Overlayed.
- [Tom Clancy's Rainbow Six® Siege](https://docs.overlayed.gg/games/siege-events.md): All of the game events emitted by Rainbow Six Siege.
- [Teamfight Tactics](https://docs.overlayed.gg/games/tft-events.md): All of the game events emitted by Teamfight Tactics.
- [Universal](https://docs.overlayed.gg/games/universal-events.md): Game events emitted for most or all games.
- [Welcome to Overlayed](https://docs.overlayed.gg/introduction.md): Effortlessly build modern, performant game overlays.
- [Keybinds](https://docs.overlayed.gg/keybinds/introduction.md): Keybinds allow your users to interact with your overlay via their keyboard.
- [Crash Dumps](https://docs.overlayed.gg/logging/crash-dumps.md): Detect and upload game crash dumps to help diagnose issues
- [Debug Mode](https://docs.overlayed.gg/logging/debug-mode.md): Enable debug mode for detailed logging and troubleshooting
- [Logging](https://docs.overlayed.gg/logging/introduction.md): Comprehensive file and console logging for your Overlayed application
- [User Feedback](https://docs.overlayed.gg/logging/user-feedback.md): Consume user bug reports and suggestions with automatic log collection
- [Notices](https://docs.overlayed.gg/notices/introduction.md): Display notices to your users directly from the Overlayed Dashboard.
- [@overlayed/ads](https://docs.overlayed.gg/packages/ads/ads.md): The methods available on the ads package
- [Changelog](https://docs.overlayed.gg/packages/ads/changelog.md)
- [Getting Started](https://docs.overlayed.gg/packages/ads/index.md): The package for integrating ads into your Overlayed app
- [@overlayed/app/security](https://docs.overlayed.gg/packages/app-security.md): Security utilities for protecting your Electron application
- [Changelog](https://docs.overlayed.gg/packages/app/changelog.md)
- [Getting Started](https://docs.overlayed.gg/packages/app/index.md): The core package for building Overlayed apps
- [Changelog](https://docs.overlayed.gg/packages/cli/changelog.md)
- [Getting Started](https://docs.overlayed.gg/packages/cli/index.md): The command-line interface for Overlayed
- [Getting Started](https://docs.overlayed.gg/packages/electron/index.md): A mandatory custom electron version for Overlayed apps
- [OverlayedConfig](https://docs.overlayed.gg/packages/overlayed-config.md): The configuration for the overlayed.config.ts file
- [OverlayedOptions](https://docs.overlayed.gg/packages/overlayed-options.md): The options object passed into the `overlayed` function
- [Quickstart](https://docs.overlayed.gg/quick-start.md): Setup a new electron app to integrate with Overlayed in just a few minutes
- [TypeScript First](https://docs.overlayed.gg/typescript.md): Everything is developed with type-safety in mind, so we strongly recommend you also use TypeScript to reap the benefits.
- [Overlay Windows](https://docs.overlayed.gg/windows/introduction.md): Windows are a core part of overlays, this guide will cover various utilities we provide for managing them.
- [Render Windows](https://docs.overlayed.gg/windows/render-windows.md): In-depth documentation on Render Windows