@overlayed/app
- fix(app): leave FCP and LCP out of
web_vitalswhen the paint they measure waited for the window to be shown, so windows created hidden and opened later no longer report the time they stayed hidden
- feat(app): windows from
createWindowandcreateInGameWindoware muted by default so ads and embedded content cannot play audio unexpectedly; pass{ muted: false }as the second argument to allow audio
- fix(app): clicking a tray menu item or using a menu accelerator (such as Ctrl+Shift+I) while in game no longer crashes the app
- fix(app): regular update checks install an older build only when the update server rolls the player back, while
switchChannelstill downgrades - fix(app): update checks compare release versions without the channel suffix, so a prerelease upgrade such as 2.0.0-rc.2 to 2.0.0-rc.10 installs and an older one is still refused; adds
semveras a dependency
- fix(app): improve how update checks handle private channel access tokens
- fix: in development, use a CLI-stored account for every application its API key is scoped to, and match application IDs in any case
- chore(deps): rebuild with vite-plus 1.3.0 (tsdown 0.23 / newer Rolldown); no public API changes
- feat(app/siege): add new Siege events
- chore(deps): bump electron-updater to 6.8.11, which rejects corrupted or path-valued cached update file names
- chore(deps): update fs-extra to 11.4.1, jszip to 3.10.2 and xior to 0.8.5 (app, cli) and systeminformation to 5.33.16 (app)
- feat(app/siege): add new Siege events
-
chore(deps): update arktype to 2.2.9
- The minimum
arktypeversion is now 2.2.9, which picks up upstream validation fixes from 2.2.3 through 2.2.9 - If your app pins
arktypeitself, move it to 2.2.9 or later so the app and@overlayed/appshare one copy and one set of types
- The minimum
- feat(app/siege): add new Siege events
-
fix(app): game module downloads are checked before they are installed
- A game module update can only add or remove files in its own module folder, and a download that fails its integrity check is refused
- A failed update now keeps the build that was already installed
- fix(app): quitting the app no longer hangs on Windows
app.quit()andapp.exit()could hang forever because the game event pipe’s background thread never stopped. The SDK now uses@overlayed-gg/native-interface0.11.1 and closes the pipe when Overlayed shuts down
-
fix(app): don’t crash when the logs folder is deleted while the app is running
- Daily log rotation no longer throws an uncaught
ENOENT ... scandir '<app>\logs'when the logs folder was removed after startup. It recreates the folder and keeps logging - A log file that can’t be opened now surfaces through the logger’s
errorevent instead of an uncaught stream error
- Daily log rotation no longer throws an uncaught
- feat(app/siege): add legend division game type
-
chore(app): bump electron peer dependency to 44.3.0
@overlayed/appnow expectselectron@44.3.0, matching@overlayed/electron@44.3.0-x. Update both together.
-
feat(app): track app crashes
The app now reports crashes to Overlayed: window and process crashes, uncaught exceptions in the main process, and sessions that ended unexpectedly. Home directories are removed from error messages before they’re sent. To opt out, pass
analytics: { crashes: false }tooverlayed(). -
feat(app): track game session duration and attach outcome
Every detected game launch now reports a
game_session_endcortex event when the game closes or the app quits, with the session duration, whether the game was subscribed and became ready, render support, and time to ready.
-
feat(app): track Core Web Vitals for overlayed windows
Windows created via
overlay.windowsnow report LCP, INP, FCP, TTFB and CLS as aweb_vitalscortex event, once per page load. Nothing to change if your preload script already imports@overlayed/app/preload, which collects the metrics. The preload grows by about 3 kB gzipped. To opt out, passanalytics: { webVitals: false }tooverlayed().
-
fix(app): harden windows against malicious ad navigation and popups
Windows created via
overlay.windowsno longer navigate their top frame to other origins, andwindow.opento another origin opens in the system browser, and only right after a user click. Nothing to change unless your app relies on one of these:- Top-frame navigation to another host (e.g. an OAuth redirect): add the host to
navigationGuard.allowedHosts. window.opento another origin in-app, or without a click: return"allow"or"external"for it fromnavigationGuard.windowOpenHandler.- Your own
webContents.setWindowOpenHandler: it can no longer open other origins in-app. Move that logic tonavigationGuard.windowOpenHandler.
- Top-frame navigation to another host (e.g. an OAuth redirect): add the host to
- fix(app): send active games in a format the API reads, so game-specific notices and game-targeted feature flags now apply
- chore(app): hash the game build natively instead of on the main process
- fix(app): only download native modules for the games the app subscribed to, instead of every game in the raven config
- fix(sand): rename
trampler_acquired.creator_account_idtocreator_player_id - feat(sand): add the live
inventory_*events
-
feat(app): add the game’s process id to the
gameLaunch,gameReadyandgameClosepayloads, and track running games per process - refactor(app): move game detection into the native module
- refactor(app): move game executable monitoring into the native module
- fix(app): don’t inject into a game that closed before its injection delay elapsed
- fix(app): remove a redundant write when staging the bundled binaries
-
feat: add the
@overlayed/app/games/sandmodule for Sand Raiders of Sophie Universal events now also reach the owning game module when that module declares the event type, so a sandlogged_inis delivered to bothoverlay.universalandoverlay.sand.
- feat(app): use the per-game
injection_delay_msfrom the raven config instead of a hardcoded 45 second wait before injecting into a freshly launched game. Games with no configured delay are injected into immediately, and processes that have already been running a while still skip the wait
- fix(build): forward VITE_* env vars to vp run build tasks so import.meta.env.VITE_API_BASE_URL/VITE_DASHBOARD_URL are actually replaced in published builds
- chore(deps): update memfs and vite-plus, and raise the Node engine floor to >=24 (LTS) so it stays aligned with commander
- fix(build): forward VITE_* env vars to vp run build tasks so import.meta.env.VITE_API_BASE_URL/VITE_DASHBOARD_URL are actually replaced in published builds
- fix(app): surface a clear error and bootstrap correctly when dev metadata is not cached yet, instead of the misleading “function overlayed was not called”
- fix(app): keep
arktypeexternal insiegeanduniversaldts so consumers don’t hitType instantiation is excessively deep/ duplicateAliasNodeerrors when usingoverlayed({ modules: [Siege.module()] }) - chore: fix error when no application is scoped
- refactor(app): export
FeatureFlagLayerstype as the named return type offeatureFlags.inspect()
-
feat(app): feature flags now accept a
Record<string, boolean>for default values and expose areadypromise for awaiting initial fetch -
feat(app): feature flags interface now supports
clearOverride,clearOverrides,isOverridden,getAllOverrides, andinspectfor introspecting and managing overrides
-
feat(app): add feature flag support via
overlay.featureFlagsmodule. Docs - chore(app): bump dependencies
- fix(app): issue where users cursor appears but the window does not, and input is blocked. Instead now the cursor wont appear and input wont be blocked.
- feat: add crash dump detection and upload support via
overlay.crashDumps.on("new", ...). See the docs for details.
-
🚀 Features
- Auto-updating support: Complete implementation of application update flow including support for private channels
- Campaigns: Ability to create UTM campaigns for tracking user acquisition
- Electron Window Logging: Logs from electron windows will now be in feedback submissions
- Ads enhancements: New
getAdsScriptElementandgetAdsScriptUrlmethods for better ads integration - Enhanced CLI bundling: Improved the CLI bundling process to be more robust and reliable
📚 Documentation Improvements
- Deployment guides: New documentation sections on application deployments and updating mechanisms
- Refreshed docs theme: Refreshed the docs theme
- Local Development: Established guideliens for local development
📝 Breaking Changes
- After updating, you’ll need to run
overlayed loginand thenoverlayed init. This only needs to be done once, and is only needed for local development.
🐛 Bug Fixes
- Fixed broken documentation links
- feat: internal changes for deployments
- feat: Add app and site updater modules [https://docs.overlay.dev/deployment/updates]
- chore(app): support nullable build_hash in module releases
- refactor: move config store internals
- chore: update meta data
- Export individual GameLaunchManager events GameLaunchEvent, GameCloseEvent, and GameReadyEvent
- chore(app): validate
applicationIDpassed tooverlayedanddefineConfigis a valid ULID feat(app/siege): addplatformto player_joined event
- feat(app/siege): add damage_hit_zone, damage_source_id to round end damage events. Also add SIEGE_DAMAGE_HIT_ZONES.
- refactor(app/siege): remove player_stats_changed event in favor of smaller events like player_kills_changed
- chore(app): export ModuleLoadedEvent, ModuleUnloadedEvent, UnsupportedGameVersionEvent types
- refactor(app/siege): move module_loaded, module_unloaded, unsupported_game_version to universal events
- Add
overlayed.universalevent listeners. Docs
- feat(siege): add constants for halloween event
- fix(app): only download dll when update is needed
- fix(app/siege): missing map id
- refactor(app/siege):
- Removed strict validation on
SiegeGameModePhase,SiegeSide,SiegePlayerLifeState,SiegeDamageType, andSiegeDamageTeamType. Now validates that its a string, but nothing more. - Add 3 new SIEGE_DAMAGE_TYPES:
"melee-pushback","supressive-fire","gas-pipe-fire", - Add 1 new SIEGE_GAME_MODE_PHASES:
"first"
- Removed strict validation on
- chore: update dependencies fix: various types exported from @overlayed/app like RenderWindow, etc.
- feat(app/siege): add missing consts for game_mode_type and maps
- chore(app/siege): remove PlayerMatchStatsDataSchema#plants
- feat(app): expose
silentoption to log internal logs to console, refactor cortex in_game internals
- fix(app/siege): add game event flushing - now you must call readyForGameEvents when you’re ready to listen to game events
- fix(app): logger doesnt include timestamp in console logs
- fix(app): dont log internal logs to console by default
- feat(app): add log.debug method which logs when debug: true is passed
- fix(app/siege): missing siege game modes
-
feat(app):
- BREAKING - Renamed
createWindowtocreateInGameWindow - BREAKING - New
createWindowmethod that should be used instead ofnew BrowserWindow - Integrate internal cortex events
- BREAKING - Renamed
- feat(app/siege): expose Translation type
- refactor(app/siege): BREAKING - expose more consts, rename existing costs to consistent naming, expose all siege vars, functions, and types at top level instead of in a Siege object.

