@lily-cooperative/custom-farm 0.36.0 → 0.38.0

package/README.md

@@ -21,7 +21,7 @@
 | 面板 | 能改什么 |
 |---|---|
 | **农场自定义 → 农场** | 地面贴图、地表高度、农田大小、导入自己的 PNG |
-| **农场自定义 → 农作物** | 增删作物、阶段数、每阶段天数、产物卖价、种子买价、各阶段/种子/产物贴图 |
+| **农场自定义 → 农作物** | 增删作物、阶段数、每阶段天数、产物卖价、种子买价、各阶段/种子/产物贴图、上下图层 |
 | **农场自定义 → 杂草** | 增删杂草、阶段与天数、出现权重、上下图层、收获物名字/价值/贴图 |
 | **农场自定义 → 浇水特效 / 枯萎** | 浇水帧序列、水花帧序列、帧间隔、枯萎贴图 |
 | **生态自定义** | 一个游戏日多长、离线最多补几天、刷新间隔、每天是否推事件、浇水蒸发/补水/枯萎天数、天气 |
@@ -61,6 +61,8 @@
 
 扩展包自带 `overlay` / `overlay-electron` / `assets`，第一次启动会把它们复制到安装目录，不需要另外准备项目文件夹。
 
+**扩展不再把 Electron 作为 npm 依赖下载。** 安装时只装扩展本身；有没有 Electron 运行时都不会影响安装。桌面图层按下面的「环境自检 / 图层引擎」选择。
+
 ### 本地开发
 
 ```powershell
@@ -71,7 +73,31 @@ powershell -NoProfile -ExecutionPolicy Bypass -File .\scripts\install.ps1
 Invoke-RestMethod -Method Post http://127.0.0.1:17788/api/run/restart
 ```
 
-## 安装路径
+## 游戏配置
+
+### 环境自检 / 图层引擎
+
+**游戏配置页顶部**有「环境自检」按钮，会检查：
+
+- 当前平台和 Node 版本
+- 是否能找到 `electron.exe`
+- 安装目录里的 `overlay-webview.ps1`、WebView2 库和 WebView2 运行时是否可用
+
+自检会明确显示「缺少 Electron 运行时」还是「WPF/WebView2 图层可用」。下面的「图层引擎」切选单可以选：
+
+- **自动**：有备用 Electron 就用，没有就用 WPF/WebView2（推荐，不会下载 Electron）
+- **备用 Electron**：只使用检测到的 Electron，需要 `electron.exe`
+- **WPF（WebView2）**：完全不使用 Electron，但加载和 Electron 相同的 `renderer.html/renderer.js`
+
+WPF 回退现在是 WebView2 宿主，不再用另一套 WPF 自绘；因此缩放、精灵位置、阴影、粒子、水滴、晃动等视觉效果和 Electron 基本完全一致。需要 Windows 10/11 自带的 WebView2 Runtime。
+
+自检里的「Electron 包」下拉会列出检测到的路径；也可以在「备用 Electron」配置项里手动选 `electron.exe`。
+
+第一次启用时还会自动做一次自检；如果当前引擎缺运行时，会推一次 `farm.env` 事件，让桌宠把“缺少 Electron 运行时 / 怎么修”转告主人。之后不会重复提醒。
+
+Coopanion 只提供打包后的 `Coopanion.exe`，没有可复用的独立 `electron.exe`；所以默认不再下载第二份 Electron。备用 Electron 可以放在安装目录的 `node_modules\electron\dist\electron.exe`，或在「备用 Electron」里手动选择路径。
+
+### 安装路径
 
 在 Coopanion 的 **游戏配置 → 安装** 里可以直接看到和修改安装路径：
 
@@ -80,12 +106,32 @@ Invoke-RestMethod -Method Post http://127.0.0.1:17788/api/run/restart
 - 存档和自定义配置仍在 `data\home\companion\data\farm\`，不会被搬走
 - 安装目录里的 `overlay\runtime\` 是运行痕迹，可以清；`assets\sprites\cust_*.png` 是你上传的贴图
 
+### 显示器
+
+**游戏配置 → 显示器** 可以选择图层放在哪块屏幕：
+
+- 「自动」使用主屏
+- 下拉里会列出当前所有显示器，改完约 1 秒内移动到目标屏幕
+- 这个设置作用于 Electron 图层；WPF/WebView2 回退使用主屏（与现有 WPF 行为一致）
+
+### 备份与重置
+
+**游戏配置** 页底部有「存档与重置」：
+
+- **备份存档**：把 `state.json` 和 `custom.json` 复制到 `data\farm\backups\backup-时间\`
+- **重置一切**：先自动备份，再清空 `state.json` 和 `custom.json`，World 自动重启并生成默认目录；安装路径和已上传的 PNG 文件不会被删除
+
+也可以从「存档与重置」页签操作同样的按钮。
+
 ## 桌面图层
 
-- **Windows 10/11**：默认 Electron/HTML 图层；Electron 不可用时回退 WPF。
-- **macOS / Linux**：核心 World、WebUI 和 Electron 图层可用；没有 Windows WPF 回退。
+- 图层拆成 `bg` / `top` 两个透明窗口：`bg` 在桌宠下面，`top` 是桌宠的 owned window，永远在桌宠上面。
+- 野草、装饰、作物、掉落物和特效按 `layer` 设置分配到两个窗口；上层野草/装饰可以正常遮挡桌宠，下层作物在桌宠后面。
+- 层级守护每 500ms 重新确认桌宠窗口；桌宠重新置顶、显示/隐藏、被点击或窗口重建后，会自动重新挂 owner / 把 `bg` 放回桌宠下面，防止图层整体翻转。
+- **Windows 10/11**：默认「自动」——检测到备用 Electron 就用 Electron，否则用 WPF/WebView2；不会为了安装扩展下载 Electron。两个引擎都使用同一套 Canvas renderer，缩放和特效一致。
+- **macOS / Linux**：暂不支持；`os` 已收紧为 `win32`。
 - 图层跟着桌宠显示/隐藏/退出；任务栏换边、换屏会重新计算位置。
-- 独立 WPF 背包已移除；背包、商店、农场预览、摆放和手动合成都在 WebUI。
+- 背包、商店、农场预览、摆放和手动合成都在 WebUI。
 
 ## 工具
 
@@ -105,7 +151,7 @@ Invoke-RestMethod -Method Post http://127.0.0.1:17788/api/run/restart
 | `farm_sell` | 卖背包里的道具 |
 | `farm_place` | 把装饰放到地上 |
 
-事件：`farm.ripe`、`farm.dry`、`farm.day`、`farm.state`。`farm.day` 默认关，`dailyEvent=true` 才推。
+事件：`farm.ripe`、`farm.dry`、`farm.day`、`farm.state`、`farm.env`。`farm.day` 默认关，`dailyEvent=true` 才推；`farm.env` 只在第一次启用自检失败时推一次，让桌宠把环境问题转告主人。
 
 ## 默认参数
 
@@ -136,7 +182,7 @@ Invoke-RestMethod -Method Post http://127.0.0.1:17788/api/run/restart
 | `dist/webui.js` / `.css` | 「自定义农场」面板 |
 | `icon.png` | 扩展图标（安装页显示） |
 | `describe.json` | 工具/事件自描述 |
-| `overlay/` | WPF 图层回退 |
+| `overlay/` | WPF/WebView2 回退（同一套渲染器） |
 | `overlay-electron/` | Electron 图层 |
 | `assets/` | 内置作物/杂草/地面/装饰/图标 |
 
@@ -150,7 +196,10 @@ Invoke-RestMethod -Method Post http://127.0.0.1:17788/api/run/restart
 
 - Coopanion `>= 0.2.13`，World API `6`
 - Node.js `>= 22`（Coopanion 自带）
-- Electron `^45.1.0`（桌面图层依赖）
+- 仅 Windows 10/11；macOS / Linux 暂不支持，等后续测试
+- Electron 不是 npm 依赖；备用 Electron 可选，Windows 没有时用 WPF/WebView2
+- WPF 回退需要 Windows 10/11 的 WebView2 Runtime（系统一般自带）
+- Windows 10/11 已实机测试；macOS / Linux 未实机测试
 
 ## 许可
 

package/describe.json

@@ -340,6 +340,14 @@
         "en": "A custom state triggered a consume action: e.g. hunger ate a crop (the text says what and the state change), or asks the pet to use farm_consume; also fires when nothing edible is in the bag."
       },
       "trigger": "debounce"
+    },
+    {
+      "type": "farm.env",
+      "description": {
+        "zh": "第一次启用时环境自检发现 Electron/WPF 运行时缺失；正文说明缺什么、怎么在「游戏配置 → 环境自检」里修复，让桌宠转告主人。",
+        "en": "The first-start environment check found a missing Electron/WPF runtime; the text says what is missing and how to fix it in Game Config → Environment check, so the pet can tell its owner."
+      },
+      "trigger": "debounce"
     }
   ]
 }

package/dist/webui.js

@@ -20,16 +20,209 @@ function renameFarmConfigTab() {
   } catch { /* 不是浏览器环境就算了 */ }
 }
 if (typeof document !== 'undefined') {
-  const start = () => {
+  const refreshFarmConfigUi = () => {
     renameFarmConfigTab();
-    new MutationObserver(renameFarmConfigTab).observe(document.body, { childList: true, subtree: true, characterData: true });
-    window.addEventListener('hashchange', renameFarmConfigTab);
-    setInterval(renameFarmConfigTab, 1000);
+    injectFarmEnvCheck();
+    injectFarmConfigActions();
+  };
+  const start = () => {
+    refreshFarmConfigUi();
+    new MutationObserver(refreshFarmConfigUi).observe(document.body, { childList: true, subtree: true, characterData: true });
+    window.addEventListener('hashchange', refreshFarmConfigUi);
+    setInterval(refreshFarmConfigUi, 1000);
   };
   if (document.body) start();
   else document.addEventListener('DOMContentLoaded', start, { once: true });
 }
 
+/** 调 World 的 manage 面板：备份 / 重置 / 自检。 */
+async function farmManageCall(method, args = []) {
+  const res = await fetch('/api/webui/providers/' + encodeURIComponent('world:farm') + '/panels/manage/' + method, {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify({ args }),
+  });
+  const data = await res.json().catch(() => ({}));
+  if (!res.ok) throw new Error(data.error || ('HTTP ' + res.status));
+  return data;
+}
+
+/** 游戏配置顶部的环境自检 + Electron/WPF 切选单。 */
+function injectFarmEnvCheck() {
+  try {
+    const hash = String(location.hash || '');
+    if (!hash.includes('world%3Afarm') && !hash.includes('world:farm')) return;
+    const view = document.querySelector('.configview');
+    if (!view || view.querySelector('[data-farm-env]')) return;
+
+    const section = document.createElement('div');
+    section.className = 'tsection';
+    section.dataset.farmEnv = '1';
+    section.textContent = '环境自检';
+
+    const desc = document.createElement('div');
+    desc.className = 'tsecdesc';
+    desc.textContent = '检查图层运行时是否齐全。Coopanion 不提供独立的 electron.exe；没有备用 Electron 时会用 WPF 图层，不会为了安装扩展再下载 Electron。';
+
+    const row = document.createElement('div');
+    row.className = 'trow';
+    const label = document.createElement('span');
+    label.className = 'tlabel';
+    label.textContent = '图层引擎';
+    const field = document.createElement('div');
+    field.className = 'tfield';
+    field.style.display = 'flex';
+    field.style.gap = '8px';
+    field.style.flexWrap = 'wrap';
+
+    const select = document.createElement('select');
+    select.className = 'field';
+    for (const [value, text] of [['auto', '自动（有备用 Electron 就用，否则 WPF/WebView2）'], ['electron', '备用 Electron（需要 electron.exe）'], ['wpf', 'WPF/WebView2（不需要 Electron）']]) {
+      const opt = document.createElement('option');
+      opt.value = value;
+      opt.textContent = text;
+      select.appendChild(opt);
+    }
+    const checkBtn = document.createElement('button');
+    checkBtn.type = 'button';
+    checkBtn.className = 'btn sm primary';
+    checkBtn.textContent = '环境自检';
+    const electronSelect = document.createElement('select');
+    electronSelect.className = 'field';
+    const electronAuto = document.createElement('option');
+    electronAuto.value = '';
+    electronAuto.textContent = 'Electron：自动查找';
+    electronSelect.appendChild(electronAuto);
+    const status = document.createElement('div');
+    status.className = 'tdesc';
+    status.style.whiteSpace = 'pre-line';
+    status.style.marginTop = '6px';
+
+    const render = (data) => {
+      if (!data) return;
+      if (data.engine) select.value = data.engine;
+      const current = data.electron && data.electron.path ? data.electron.path : '';
+      electronSelect.replaceChildren(electronAuto);
+      electronAuto.textContent = 'Electron：自动查找';
+      for (const row of data.electronCandidates || []) {
+        const opt = document.createElement('option');
+        opt.value = row.path;
+        opt.textContent = 'Electron：' + row.label + (row.ok ? '' : '（缺失）');
+        opt.disabled = !row.ok;
+        electronSelect.appendChild(opt);
+      }
+      if (current) electronSelect.value = current;
+      if (!current && !(data.electronCandidates || []).some((r) => r.ok)) {
+        const opt = document.createElement('option');
+        opt.value = '';
+        opt.textContent = 'Electron：未找到';
+        opt.disabled = true;
+        electronSelect.appendChild(opt);
+      }
+      status.textContent = data.message || data.text || '';
+      status.style.color = data.ok ? '' : 'var(--extension-alert, #c0392b)';
+    };
+    const check = async () => {
+      checkBtn.disabled = true;
+      try { render(await farmManageCall('check')); } catch (err) { status.textContent = '自检失败：' + ((err && err.message) || err); } finally { checkBtn.disabled = false; }
+    };
+    checkBtn.addEventListener('click', check);
+    select.addEventListener('change', async () => {
+      status.textContent = '正在切换图层引擎…';
+      try {
+        render(await farmManageCall('setEngine', [select.value]));
+      } catch (err) {
+        status.textContent = '切换失败：' + ((err && err.message) || err);
+      }
+    });
+    electronSelect.addEventListener('change', async () => {
+      status.textContent = '正在切换 Electron…';
+      try {
+        render(await farmManageCall('setElectronPath', [electronSelect.value]));
+      } catch (err) {
+        status.textContent = '切换失败：' + ((err && err.message) || err);
+      }
+    });
+
+    field.append(select, electronSelect, checkBtn);
+    row.append(label, field);
+    view.prepend(section, desc, row, status);
+    void check();
+  } catch { /* 不是宿主的配置页就算了 */ }
+}
+
+/** 往宿主的「游戏配置」页里塞「存档与重置」按钮。 */
+function injectFarmConfigActions() {
+  try {
+    const hash = String(location.hash || '');
+    if (!hash.includes('world%3Afarm') && !hash.includes('world:farm')) return;
+    const view = document.querySelector('.configview');
+    if (!view || view.querySelector('[data-farm-manage]')) return;
+
+    const section = document.createElement('div');
+    section.className = 'tsection';
+    section.dataset.farmManage = '1';
+    section.textContent = '存档与重置';
+
+    const desc = document.createElement('div');
+    desc.className = 'tsecdesc';
+    desc.textContent = '备份会复制 state.json 和 custom.json 到 data/farm/backups；重置会先备份，再清空存档和全部自定义设置，World 随后重启。';
+
+    const row = document.createElement('div');
+    row.className = 'trow';
+    const label = document.createElement('span');
+    label.className = 'tlabel';
+    label.textContent = '操作';
+    const field = document.createElement('div');
+    field.className = 'tfield';
+    field.style.display = 'flex';
+    field.style.gap = '8px';
+    field.style.flexWrap = 'wrap';
+    const status = document.createElement('span');
+    status.className = 'tdesc';
+    status.setAttribute('role', 'status');
+
+    const button = (text, primary) => {
+      const b = document.createElement('button');
+      b.type = 'button';
+      b.className = 'btn sm' + (primary ? ' primary' : '');
+      b.textContent = text;
+      return b;
+    };
+    const backup = button('备份存档', true);
+    const reset = button('重置一切', false);
+
+    backup.addEventListener('click', async () => {
+      backup.disabled = true;
+      status.textContent = '正在备份…';
+      try {
+        const r = await farmManageCall('backup');
+        status.textContent = r.text || '已备份';
+      } catch (err) {
+        status.textContent = '备份失败：' + ((err && err.message) || err);
+      } finally { backup.disabled = false; }
+    });
+
+    reset.addEventListener('click', async () => {
+      if (!window.confirm('确定重置一切？会清空存档和全部自定义设置（会先自动备份）。')) return;
+      reset.disabled = true;
+      status.textContent = '正在重置…';
+      try {
+        const r = await farmManageCall('reset');
+        status.textContent = r.text || '已重置，World 正在重启…';
+        setTimeout(() => { try { location.reload(); } catch { /* ignore */ } }, 3000);
+      } catch (err) {
+        status.textContent = '重置失败：' + ((err && err.message) || err);
+        reset.disabled = false;
+      }
+    });
+
+    field.append(backup, reset, status);
+    row.append(label, field);
+    view.append(section, desc, row);
+  } catch { /* 不是宿主的配置页就算了 */ }
+}
+
 const TEXT = {
   zh: {
     title: '农场',
@@ -84,6 +277,9 @@ const TEXT = {
     weedLayer: '图层',
     weedLayerTop: '上（和作物/桌宠同前台层）',
     weedLayerBottom: '下（背景层，作物后方）',
+    cropLayer: '图层',
+    cropLayerTop: '上（和桌宠同前台层）',
+    cropLayerBottom: '下（背景层，桌宠后方）',
     addWeed: '添加杂草',
     name: '名字',
     stages: '阶段数',
@@ -188,6 +384,9 @@ const TEXT = {
     weedLayer: 'Layer',
     weedLayerTop: 'Top (foreground with crops/pet)',
     weedLayerBottom: 'Bottom (background, behind crops)',
+    cropLayer: 'Layer',
+    cropLayerTop: 'Top (foreground with pet)',
+    cropLayerBottom: 'Bottom (background, behind pet)',
     addWeed: 'Add weed',
     name: 'Name',
     stages: 'Stages',
@@ -483,6 +682,7 @@ function panel(ctx) {
       preview: [...c.preview],
       previewSeed: c.previewSeed,
       previewItem: c.previewItem,
+      layer: c.layer === 'top' ? 'top' : 'bottom',
     };
     const details = ui.h('details', 'cf-card');
     if (!c.builtin) details.open = false;
@@ -493,10 +693,20 @@ function panel(ctx) {
       ui.pill(c.builtin ? T.builtin : T.custom, c.builtin ? 'plain' : 'on'),
       ui.chip(c.stages + ' 阶段', 'plain'),
       ui.chip(T.daysTotal(c.totalDays), 'plain'),
+      ui.chip(c.layer === 'top' ? T.cropLayerTop : T.cropLayerBottom, c.layer === 'top' ? 'on' : 'plain'),
     );
     const body = ui.h('div', 'cf-body');
     details.append(summary, body);
 
+    const layerSel = ui.select({
+      value: draft.layer,
+      options: [
+        { value: 'top', label: T.cropLayerTop },
+        { value: 'bottom', label: T.cropLayerBottom },
+      ],
+    });
+    layerSel.addEventListener('change', () => { draft.layer = layerSel.value; }, { signal: ctx.signal });
+
     const row1 = ui.h('div', 'cf-row');
     row1.append(
       ui.field(T.name, textInput(draft.name, (v) => { draft.name = v; title.textContent = v || c.key; })),
@@ -506,6 +716,7 @@ function panel(ctx) {
         resizeSprites(draft);
         paintStages();
       })),
+      ui.field(T.cropLayer, layerSel),
     );
 
     const stagesBox = ui.h('div', 'cf-stages');
@@ -566,6 +777,7 @@ function panel(ctx) {
           sprites: draft.sprites,
           seedSprite: draft.seedSprite,
           itemSprite: draft.itemSprite,
+          layer: draft.layer,
         }], { toast: T.saved });
         off.dispose();
       })(),
@@ -2700,8 +2912,64 @@ function ecologyPanel(ctx) {
   reload();
 }
 
+function managePanel(ctx) {
+  const { ui } = ctx;
+  const root = ui.h('div', 'cf-root');
+  ctx.root.appendChild(root);
+  const sheet = ui.sheet({
+    title: '存档与重置',
+    desc: '备份会复制 state.json 和 custom.json 到 data/farm/backups；重置会先备份，再清空存档和全部自定义设置，World 随后重启。',
+  });
+  const bar = ui.rowbar();
+  const status = ui.h('p', 'cf-note', '');
+  const check = ui.button('环境自检', {
+    onClick: async () => {
+      check.disabled = true;
+      status.textContent = '正在检查…';
+      try {
+        const r = await ctx.invoke('check');
+        status.textContent = r.message || r.text || '';
+      } catch (err) {
+        status.textContent = '自检失败：' + ((err && err.message) || err);
+      } finally { check.disabled = false; }
+    },
+  });
+  const backup = ui.button('备份存档', {
+    variant: 'primary',
+    onClick: async () => {
+      backup.disabled = true;
+      status.textContent = '正在备份…';
+      try {
+        const r = await ctx.invoke('backup');
+        status.textContent = r.text || '已备份';
+      } catch (err) {
+        status.textContent = '备份失败：' + ((err && err.message) || err);
+      } finally { backup.disabled = false; }
+    },
+  });
+  const reset = ui.button('重置一切', {
+    onClick: async () => {
+      if (!window.confirm('确定重置一切？会清空存档和全部自定义设置（会先自动备份）。')) return;
+      reset.disabled = true;
+      status.textContent = '正在重置…';
+      try {
+        const r = await ctx.invoke('reset');
+        status.textContent = r.text || '已重置，World 正在重启…';
+        setTimeout(() => { try { location.reload(); } catch { /* ignore */ } }, 3000);
+      } catch (err) {
+        status.textContent = '重置失败：' + ((err && err.message) || err);
+        reset.disabled = false;
+      }
+    },
+  });
+  bar.append(check, backup, reset);
+  sheet.body.append(bar, status);
+  root.appendChild(sheet.el);
+}
+
 export default {
   panels: {
+    manage: { mount: managePanel },
     bag: { mount: bagPanel },
     shop: { mount: shopPanel },
     customize: { mount: panel },

package/overlay/README.md

@@ -1,5 +1,9 @@
 # 桌面图层（overlay）· 使用说明
 
+> 运行时 WPF 回退已改为 WebView2 宿主 `overlay-webview.ps1`，加载与 Electron 相同的
+> `overlay-electron/renderer.html` / `renderer.js`；本文档描述的是保留的旧 WPF 自绘
+> 实现（`overlay.ps1`），正常启动不再使用它。
+>
 > v4：作物种在任务栏上沿的全宽透明条带上；统一缩放、掉落物、摇晃、浇水/枯萎特效、
 > 收割的作物**不发光**。图层只渲染，状态全从 `state.json` 读。