@next2d/builder 0.4.1 → 0.4.3

package/docs/steam.md

@@ -101,8 +101,12 @@ Steamは複数Depotに対応。builderは各OSに1 IDまでで、一部OSだけ
 await window.next2dWindow?.setIgnoreMouseEvents(false); // キャラクター上では操作を受け付ける
 const { x, y, width, height, scaleFactor } = await window.next2dWindow.getBounds();
 await window.next2dWindow.quit();
+// スリープ復帰・画面ロック解除のあとに呼ばれる（重ね表示の状態は再適用済み。ページ側の状態を合わせ直す）
+const off = window.next2dWindow.onResume(() => { /* 状態の再送など */ });
 ```
 
+重ね表示が有効なときは、アプリは**1つだけ**起動します（2つ目の起動はすぐに終了します。macOSではDockにアイコンも出しません）。開発中に複数起動したいときは `--next2d-allow-multiple` を付けて起動します。
+
 Linuxの透明表示はコンポジタが必要です。
 
 ### STEP4：認証を用意する
@@ -317,8 +321,12 @@ Only when enabled, the renderer gets `window.next2dWindow` (app main frame only)
 await window.next2dWindow?.setIgnoreMouseEvents(false); // accept input while over the character
 const { x, y, width, height, scaleFactor } = await window.next2dWindow.getBounds();
 await window.next2dWindow.quit();
+// Called after the PC wakes from sleep or the screen is unlocked (the overlay state was applied again; resync the page)
+const off = window.next2dWindow.onResume(() => { /* resend state, etc. */ });
 ```
 
+With the overlay enabled the app runs **once**: a second launch quits at once (and, on macOS, never shows a Dock icon). Start with `--next2d-allow-multiple` to run several copies while developing.
+
 Transparency on Linux requires a compositor.
 
 ### STEP4: Prepare credentials

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next2d/builder",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Multi-platform builder for Next2d Framework, supporting export to various platforms such as macOS, Windows, iOS, Android and Web(HTML)",
   "author": "Toshiyuki Ienaga <ienaga@next2d.app>",
   "license": "MIT",

package/templates/electron/index.js

@@ -1,4 +1,4 @@
-const { app, BrowserWindow, Menu, net, protocol, screen, session, ipcMain } = require("electron");
+const { app, BrowserWindow, Menu, net, powerMonitor, protocol, screen, session, ipcMain } = require("electron");
 const path = require("node:path");
 const fs = require("node:fs");
 const { pathToFileURL } = require("node:url");
@@ -13,6 +13,15 @@ app.on("before-quit", closeNativeBridge);
 app.setName(config.appName);
 const userDataOverride = app.commandLine.getSwitchValue("user-data-dir");
 app.setPath("userData", userDataOverride ? path.resolve(userDataOverride) : path.join(app.getPath("appData"), config.appId));
+
+// A desktop overlay (a pet that stays on screen) must run once. A second launch quits at once (macOS: before
+// it can show a Dock icon). The lock is tied to the userData path set above, so it needs to come after it.
+const singleInstance = !app.commandLine.hasSwitch("next2d-allow-multiple") && Boolean(config.window.overlay?.enabled);
+const hasLock = !singleInstance || app.requestSingleInstanceLock();
+if (!hasLock) {
+    if (process.platform === "darwin") app.dock?.hide();
+    app.exit(0);
+}
 const assetRoot = app.isPackaged
     ? path.join(process.resourcesPath, "resources")
     : path.join(__dirname, "resources");
@@ -26,6 +35,8 @@ protocol.registerSchemesAsPrivileged([{
 const startURL = "next2d://game/index.html";
 const overlay = config.window.overlay?.enabled ? config.window.overlay : null;
 let mainWindow;
+// The last click-through state asked for, so it can be applied again after sleep/lock.
+let overlayIgnore = Boolean(config.window.overlay?.enabled && config.window.overlay.clickThrough);
 // Bottom anchor: flush with the primary display's work area (above the taskbar/Dock), centred.
 const overlayBounds = () => {
     const { workArea } = screen.getPrimaryDisplay();
@@ -40,6 +51,21 @@ const overlayBounds = () => {
 const placeOverlay = () => {
     if (mainWindow && !mainWindow.isDestroyed()) mainWindow.setBounds(overlayBounds());
 };
+// The overlay never takes focus, so Windows does not raise it when another topmost window (the taskbar, another
+// always-on-top app) is activated, nor after the display is turned off and on. Put it back on top.
+const keepOnTop = () => {
+    if (!mainWindow || mainWindow.isDestroyed()) return;
+    mainWindow.setAlwaysOnTop(true, "floating");
+    mainWindow.moveTop();
+};
+// Windows forwards mouse moves to a click-through window with a system mouse hook, and Electron installs it only
+// when forwarding switches on. After sleep (closing the lid) the hook can be gone while Electron still thinks it is
+// installed, so the page never sees the pointer. Switching forwarding off and on again installs a fresh hook.
+const refreshForwarding = () => {
+    if (!overlayIgnore || !mainWindow || mainWindow.isDestroyed()) return;
+    mainWindow.setIgnoreMouseEvents(false);
+    mainWindow.setIgnoreMouseEvents(true, { forward: true });
+};
 const createWindow = async () => {
     const { width, height } = screen.getPrimaryDisplay().workAreaSize;
     // The preload reads these flags; each API is exposed only when its feature is configured.
@@ -78,10 +104,16 @@ const createWindow = async () => {
             mainWindow.setIgnoreMouseEvents(true, { forward: true });
         }
         const events = ["display-metrics-changed", "display-added", "display-removed"];
-        for (const name of events) screen.on(name, placeOverlay);
+        const onDisplayChange = () => { placeOverlay(); keepOnTop(); };
+        for (const name of events) screen.on(name, onDisplayChange);
         mainWindow.once("closed", () => {
-            for (const name of events) screen.removeListener(name, placeOverlay);
+            for (const name of events) screen.removeListener(name, onDisplayChange);
         });
+        if (process.platform === "win32") {
+            const timer = setInterval(() => { keepOnTop(); refreshForwarding(); }, 3000);
+            timer.unref?.();
+            mainWindow.once("closed", () => clearInterval(timer));
+        }
     }
     mainWindow.webContents.setWindowOpenHandler(() => ({ action: "deny" }));
     mainWindow.webContents.on("will-navigate", (event, url) => {
@@ -111,6 +143,7 @@ const createWindow = async () => {
 };
 
 app.whenReady().then(async () => {
+    if (!hasLock) return;
     Menu.setApplicationMenu(process.platform === "darwin" ? Menu.buildFromTemplate([
         { role: "appMenu" }, { role: "editMenu" }, { role: "windowMenu" }
     ]) : null);
@@ -156,6 +189,7 @@ app.whenReady().then(async () => {
         ipcMain.handle("next2d:window:set-ignore-mouse-events", (event, ignore) => {
             trusted(event);
             if (typeof ignore !== "boolean") throw new TypeError("ignore must be a boolean");
+            overlayIgnore = ignore;
             mainWindow.setIgnoreMouseEvents(ignore, ignore ? { forward: true } : undefined);
         });
         ipcMain.handle("next2d:window:get-bounds", (event) => {
@@ -163,6 +197,17 @@ app.whenReady().then(async () => {
             const bounds = mainWindow.getBounds();
             return { ...bounds, scaleFactor: screen.getDisplayMatching(bounds).scaleFactor };
         });
+        // After sleep or screen lock the OS can drop the mouse-forwarding hook and reset the window's
+        // z-order/bounds. Apply the overlay state again and tell the page so it can recover too.
+        const recoverOverlay = () => {
+            if (!mainWindow || mainWindow.isDestroyed()) return;
+            keepOnTop();
+            placeOverlay();
+            mainWindow.setIgnoreMouseEvents(false);
+            mainWindow.setIgnoreMouseEvents(overlayIgnore, overlayIgnore ? { forward: true } : undefined);
+            mainWindow.webContents.send("next2d:window:resume");
+        };
+        for (const name of ["resume", "unlock-screen"]) powerMonitor.on(name, () => setTimeout(recoverOverlay, 1000));
         ipcMain.handle("next2d:window:quit", (event) => {
             trusted(event);
             // Reply before the window is torn down.
@@ -175,5 +220,15 @@ app.whenReady().then(async () => {
     app.exit(1);
 });
 
+if (singleInstance && hasLock) {
+    // Launching again does nothing visible; just make sure the overlay is still shown on top.
+    app.on("second-instance", () => {
+        if (mainWindow && !mainWindow.isDestroyed()) {
+            mainWindow.setAlwaysOnTop(true, "floating");
+            if (!mainWindow.isVisible()) mainWindow.showInactive();
+        }
+    });
+}
+
 // Closing the game must stop Steam's "Running" status, including on macOS.
 app.on("window-all-closed", () => app.quit());

package/templates/electron/preload.cjs

@@ -21,6 +21,13 @@ if (flags.has("--next2d-overlay")) {
             await ipcRenderer.invoke("next2d:window:set-ignore-mouse-events", ignore);
         },
         getBounds: () => ipcRenderer.invoke("next2d:window:get-bounds"),
-        quit: async () => { await ipcRenderer.invoke("next2d:window:quit"); }
+        quit: async () => { await ipcRenderer.invoke("next2d:window:quit"); },
+        // Fires after the PC wakes from sleep or the screen is unlocked (the overlay state was applied again).
+        onResume: (listener) => {
+            if (typeof listener !== "function") throw new TypeError("Expected resume listener");
+            const handler = () => listener();
+            ipcRenderer.on("next2d:window:resume", handler);
+            return () => ipcRenderer.removeListener("next2d:window:resume", handler);
+        }
     });
 }