Electron-based overlay window launcher and manager.
-
Purpose: Provides a small menu window to open and manage overlay windows. Overlays can load either local UI or remote URLs and support frameless transparent windows for in-game overlays.
-
Main entry: main.js
-
UI files: menu.html, window.html, test.html
-
Styles: css/ (fonts.css, menu.css, window.css)
-
Fonts: fonts/
Run (development):
- Install dependencies (Electron is required):
npm install- Start the app:
npm start(The start script runs electron . as defined in package.json.)
Key behavior & IPC channels
-
main.jscreates a small menu window (menu.html) and can spawn overlay windows viacreateOverlayWindow(). -
Overlays support two modes:
- Remote: loads a URL in a framed window (OS window controls enabled).
- Local: loads
window.htmlin a frameless, transparent window suited for in-game overlays.
-
IPC channels used by the app:
window:minimize— minimize the sending windowwindow:close— close/destroy the sending windowwindow:getBounds— returns current window boundswindow:setBounds— apply new window bounds (resize/move)menu:openOverlay— request opening a new overlay (payload may be a string title or{ title, url })
Notes & requirements
- Requires Node.js and Electron. If Electron is not installed locally, install it as a devDependency or globally:
npm install --save-dev electron
# or
npm install -g electron- This repository doesn't bundle overlays;
menu.htmlis the launcher UI andwindow.htmlis the local overlay UI.
Files to inspect
- main.js — app entry and window management logic
- menu.html — launcher UI
- window.html — local overlay UI
If you want, I can:
- add a short README section showing how to build an overlay payload example
- add a
devDependenciesentry forelectroninpackage.json - create a simple overlay example inside
window.html