dsh-pet-live2d 2.3.4 → 3.0.1

package/lib/index.js

@@ -27,6 +27,10 @@ import { homedir } from 'node:os'
 import { dirname, extname, join, sep } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
+import { createDisplayLayer } from './display.js'
+import { desktopHint, desktopSupported, resolveDesktopBinary } from './desktop.js'
+import { readSettings, writeSettings } from './settings.js'
+
 export const name = 'live2d-pet'
 
 export const inject = ['webServer']
@@ -1300,8 +1304,7 @@ export function attachActivityEvents(ctx, hub) {
 }
 
 /** The activity stream + snapshot route. */
-function eventsRoute(hub) {
-  return {
+function eventsRoute(hub) {  return {
     kind: 'exact',
     path: API + '/events',
     handler: (request, response) => {
@@ -1350,17 +1353,155 @@ function eventsRoute(hub) {
   }
 }
 
+/**
+ * 显示层路由：桌宠在页面内还是桌面上。
+ *
+ * `GET` 给浏览器（它每秒问一次"现在该谁管这只宠物"），`POST` 给设置页（改偏好）。
+ * **页面只读、不写** —— 判定与"拉起/收掉桌面端"都在宿主半区，两个写者会互相擦。
+ */
+function layerRoute(display) {
+  return {
+    kind: 'exact',
+    path: API + '/layer',
+    handler: async (request, response) => {
+      if (!loopbackOnly(request)) {
+        response.writeHead(403)
+        response.end()
+        return
+      }
+      if (request.method === 'POST') {
+        let body = ''
+        try {
+          for await (const chunk of request) body += chunk
+          const parsed = JSON.parse(body === '' ? '{}' : body)
+          // `{action:"download-desktop"}`：把平台子包拉下来。**先回话、后台下** ——
+          // 让这个请求等 5MB 下完的话，页面每秒的轮询会被堵住，观感是"卡住了"。
+          if (parsed.action === 'download-desktop') {
+            const started = display.startDownload()
+            sendJson(response, 200, { ok: true, download: started, ...display.reconcile(), binary: display.binaryInfo() })
+            return
+          }
+          display.setMode(parsed.mode)
+        } catch {
+          sendJson(response, 400, { ok: false, error: 'bad-body' })
+          return
+        }
+      } else if (request.method !== 'GET' && request.method !== 'HEAD') {
+        response.writeHead(405, { allow: 'GET, HEAD, POST' })
+        response.end()
+        return
+      }
+      // 页面自己报来的地址就是 DSH 的地址（端口是配置的，猜会猜错）。
+      const origin = request.headers?.origin
+      if (typeof origin === 'string') display.setDshUrl(origin)
+      // 每次读状态都顺手 reconcile 一次：设置页点完马上能看到结果，不用等下一个 tick。
+      const status = display.reconcile()
+      sendJson(response, 200, {
+        ok: true,
+        ...status,
+        // 下载进度：设置页靠每秒的轮询把它显示出来。
+        download: display.downloadState(),
+        // 二进制在不在 —— 设置页那一行要如实告诉用户"下一句该干什么"。
+        binary: display.binaryInfo(),
+      })
+    },
+  }
+}
+
+/**
+ * 共享设置路由（`GET|POST /api/live2d-pet/settings`）。
+ *
+ * 为什么需要它：桌面端页面与 DSH 页面**不是同一个 origin**（壳有自己的随机端口），
+ * localStorage 按 origin 隔离 ⇒ 两边各存一份、永不互见（用户报的"桌面的设置与 DSH 里的
+ * 设置没有同步"）。所以设置要放到两端都能读的地方：`%DSH_HOME%\pet-settings.json`。
+ *
+ * 只同步三类**共享**项（tuning / overrides / outfit）；窗口自己的位置与大小不在这里。
+ */
+function settingsRoute(home) {
+  return {
+    kind: 'exact',
+    path: API + '/settings',
+    handler: async (request, response) => {
+      if (!loopbackOnly(request)) {
+        response.writeHead(403)
+        response.end()
+        return
+      }
+      if (request.method === 'POST') {
+        let body = ''
+        try {
+          for await (const chunk of request) body += chunk
+          const parsed = JSON.parse(body === '' ? '{}' : body)
+          const written = writeSettings(home, parsed)
+          if (written === null) {
+            sendJson(response, 500, { ok: false, error: 'write-failed' })
+            return
+          }
+          sendJson(response, 200, { ok: true, ...written })
+          return
+        } catch {
+          sendJson(response, 400, { ok: false, error: 'bad-body' })
+          return
+        }
+      }
+      if (request.method !== 'GET' && request.method !== 'HEAD') {
+        response.writeHead(405, { allow: 'GET, HEAD, POST' })
+        response.end()
+        return
+      }
+      sendJson(response, 200, { ok: true, ...readSettings(home) })
+    },
+  }
+}
+
 /** The complete route table this plugin owns. */
-export function buildRoutes(hub) {
-  return [catalogRoute(), assetRoute(), runtimeRoute(), eventsRoute(hub)]
+export function buildRoutes(hub, display, home) {
+  const routes = [catalogRoute(), assetRoute(), runtimeRoute(), eventsRoute(hub)]
+  if (display !== undefined) routes.push(layerRoute(display))
+  // 共享设置：不依赖显示层（测试里也可能只给 home）。
+  if (typeof home === 'string' && home !== '') routes.push(settingsRoute(home))
+  return routes
 }
 
 export function apply(ctx) {
   const hub = new ActivityHub()
   attachActivityEvents(ctx, hub)
   ctx.effect(() => () => hub.dispose(), 'live2d-pet: activity hub')
+
+  // 显示层：每秒一次"按偏好把两边摆正"。桌面端的二进制由平台子包带下来
+  // （`lib/desktop.js`），没有就只是提示，不影响页面内那只。
+  const display = createDisplayLayer({
+    home: dshHome(),
+    hint: desktopHint({ home: dshHome() }),
+    resolveBinary: () => resolveDesktopBinary({ home: dshHome() }),
+    log: (message) => console.log('[live2d-pet] ' + message),
+  })
+  // 宿主侧把它挂出来：设置路由与 `/api/live2d-pet/layer` 共用同一个控制器。
+  display.binaryInfo = () => {
+    const found = resolveDesktopBinary({ home: dshHome() })
+    return {
+      found: found !== undefined,
+      path: found?.path ?? null,
+      source: found?.source ?? null,
+      supported: desktopSupported(),
+      hint: desktopHint({ home: dshHome() }),
+    }
+  }
+  const tick = setInterval(() => {
+    try {
+      display.reconcile()
+    } catch (error) {
+      console.log('[live2d-pet] 显示层 reconcile 失败：' + String(error && error.message))
+    }
+  }, 1000)
+  tick.unref?.()
+  ctx.effect(() => () => {
+    clearInterval(tick)
+    display.dispose()
+  }, 'live2d-pet: display layer')
+
   ctx.inject(['webServer'], (host) => {
-    for (const route of buildRoutes(hub)) {
+    for (const route of buildRoutes(hub, display, dshHome())) {
       try {
         host.effect(() => host.webServer.register(route), 'live2d-pet: route ' + route.path)
       } catch (error) {

package/lib/settings.js

@@ -0,0 +1,98 @@
+// 设置存档（宿主半区）：**一份两端共享的设置**，落在 `%DSH_HOME%\pet-settings.json`。
+//
+// 为什么必须有它（用户报的"桌面的设置与 DSH 里的设置没有同步"）：
+// 设置原来只存在 `window.localStorage` 里，而**桌面端页面与 DSH 页面不是同一个 origin**：
+//
+//   桌面端：http://127.0.0.1:<壳的随机端口>     ← `--attach` 模式下页面由壳转发
+//   DSH：   http://127.0.0.1:3080
+//
+// 浏览器按 origin 隔离 localStorage，所以两边各有一份、永不互见 —— 不是"同步没做"，
+// 而是**根本没有共享的存储**。显示层（`pet-desktop.json`）早就踩过同一个问题，
+// 解法也一样：把共享状态放到一个两端都能读写的文件里。
+//
+// 三个键（与客户端的三类 shared 存档一一对应）：
+//
+//   tuning     ← `dsh-pet-live2d.settings.v1`  可调项（手感、池子节奏…）
+//   overrides  ← `dsh-pet-live2d.settings.v2`  相位池子覆盖 + 开关 + 反应清空
+//   outfit     ← `dsh-pet-live2d:outfit`       装扮槽位的选择
+//
+// **位置与大小不在里面**（`dsh-live2d-pet.state.v1`）：那个必须每个窗口各不相同
+// （桌面上她贴屏幕右下角、DSH 页面里她贴面板右下角），共享了反而会打架。
+//
+// Rust 侧的对应实现见 `dsh-live2d-pet-desktop/src-tauri/src/host/settings.rs`：
+// 独立模式下壳直接读写这个文件；挂载模式下页面读的仍是 DSH 的这条路由。
+import { readFileSync, writeFileSync, mkdirSync } from 'node:fs'
+import { dirname, join } from 'node:path'
+
+/** 存档里的键（客户端与 Rust 侧都按这三个名字读写）。 */
+export const SETTINGS_KEYS = ['tuning', 'overrides', 'outfit']
+
+export function settingsPath(home) {
+  return join(home, 'pet-settings.json')
+}
+
+/**
+ * 读共享设置。
+ *
+ * 返回 `{ tuning, overrides, outfit, rev, at }`；键缺失就是 `null`（"这一项用户没改过"）。
+ * `rev` 每次写入 +1 —— 页面用它判断"我这份是不是旧的"，也用它避免自己写自己读的回环。
+ */
+export function readSettings(home) {
+  const empty = { tuning: null, overrides: null, outfit: null, rev: 0, at: 0 }
+  let parsed = null
+  try {
+    parsed = JSON.parse(readFileSync(settingsPath(home), 'utf8'))
+  } catch {
+    return empty
+  }
+  if (parsed === null || typeof parsed !== 'object') return empty
+  const out = Object.assign({}, empty)
+  for (const key of SETTINGS_KEYS) {
+    const value = parsed[key]
+    // 只接受对象：存档被人手改坏时不要把它传染给页面。
+    if (value !== null && typeof value === 'object' && !Array.isArray(value)) out[key] = value
+  }
+  if (typeof parsed.rev === 'number' && parsed.rev >= 0) out.rev = parsed.rev
+  if (typeof parsed.at === 'number' && parsed.at >= 0) out.at = parsed.at
+  return out
+}
+
+/**
+ * 写共享设置（**合并写**：只动传进来的那几项，别把别的窗口写的擦掉）。
+ *
+ * 返回写好之后的那一份（含新的 `rev`）。写失败时返回 `null` —— 调用方要能区分
+ * "没写成功"和"写成功了"，否则页面会以为同步好了。
+ */
+export function writeSettings(home, patch) {
+  if (patch === null || typeof patch !== 'object') return null
+  const current = readSettings(home)
+  const next = {
+    tuning: current.tuning,
+    overrides: current.overrides,
+    outfit: current.outfit,
+    rev: current.rev + 1,
+    at: Date.now(),
+  }
+  let touched = false
+  for (const key of SETTINGS_KEYS) {
+    const value = patch[key]
+    if (value === null) continue          // 没传 = 不动这一项
+    if (value === undefined) continue
+    if (typeof value !== 'object' || Array.isArray(value)) continue
+    next[key] = value
+    touched = true
+  }
+  // **没有实际内容就不算一次写入**：不推进 `rev`、也不落盘。
+  //
+  // 这一条是防回环的：页面按 `rev` 判断"我这份是不是旧的"，如果"只带 rev 的空写"也推进
+  // 版本号，另一个窗口就会以为有变化、于是回写一次 → 互相推着转。
+  // （单元测试先红在这里，才有了这条注释。）
+  if (!touched) return current
+  try {
+    mkdirSync(dirname(settingsPath(home)), { recursive: true })
+    writeFileSync(settingsPath(home), JSON.stringify(next, null, 2) + '\n')
+    return next
+  } catch {
+    return null
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-pet-live2d",
-  "version": "2.3.4",
+  "version": "3.0.1",
   "description": "Live2D 桌宠插件：为 DSH Web GUI 挂一只可拖动、会跟随鼠标、能换动作与表情的 Live2D 宠物。",
   "type": "module",
   "main": "lib/index.js",
@@ -19,6 +19,7 @@
     "docs",
     "pets",
     "cordis.patch.yml",
+    "screenshots.json",
     "README.md",
     "CHANGELOG.md",
     "LICENSE"
@@ -28,6 +29,7 @@
       "default": "./lib/index.js"
     },
     "./client": "./lib/client.js",
+    "./desktop": "./lib/desktop.js",
     "./cordis.patch.yml": "./cordis.patch.yml",
     "./package.json": "./package.json"
   },
@@ -46,6 +48,9 @@
       "platform": "web"
     }
   },
+  "optionalDependencies": {
+    "dsh-pet-live2d-desktop-win32-x64": "3.0.1"
+  },
   "devDependencies": {
     "esbuild": "^0.25.10",
     "pixi.js": "8.19.0",

package/pets/ds-whale-girl/pet.json

@@ -42,6 +42,11 @@
       },
       "OpenCase": {
         "hold": true
+      },
+      "Selfie": {
+        "holdParams": {
+          "phone5": 10
+        }
       }
     },
     "expressionSlots": [

package/screenshots.json

@@ -0,0 +1,5 @@
+[
+  "docs/banner.png",
+  "docs/panel.jpg",
+  "docs/looks.jpg"
+]