@lily-cooperative/custom-farm 0.36.0 → 0.37.0

package/README.md

@@ -71,7 +71,9 @@ powershell -NoProfile -ExecutionPolicy Bypass -File .\scripts\install.ps1
 Invoke-RestMethod -Method Post http://127.0.0.1:17788/api/run/restart
 ```
 
-## 安装路径
+## 游戏配置
+
+### 安装路径
 
 在 Coopanion 的 **游戏配置 → 安装** 里可以直接看到和修改安装路径：
 
@@ -80,6 +82,23 @@ 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 回退仍跟随桌宠所在屏幕
+
+### 备份与重置
+
+**游戏配置** 页底部有「存档与重置」：
+
+- **备份存档**：把 `state.json` 和 `custom.json` 复制到 `data\farm\backups\backup-时间\`
+- **重置一切**：先自动备份，再清空 `state.json` 和 `custom.json`，World 自动重启并生成默认目录；安装路径和已上传的 PNG 文件不会被删除
+
+也可以从「存档与重置」页签操作同样的按钮。
+
 ## 桌面图层
 
 - **Windows 10/11**：默认 Electron/HTML 图层；Electron 不可用时回退 WPF。
@@ -151,6 +170,7 @@ 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 未实机测试
 
 ## 许可
 

package/dist/webui.js

@@ -22,14 +22,99 @@ function renameFarmConfigTab() {
 if (typeof document !== 'undefined') {
   const start = () => {
     renameFarmConfigTab();
-    new MutationObserver(renameFarmConfigTab).observe(document.body, { childList: true, subtree: true, characterData: true });
-    window.addEventListener('hashchange', renameFarmConfigTab);
-    setInterval(renameFarmConfigTab, 1000);
+    injectFarmConfigActions();
+    new MutationObserver(() => { renameFarmConfigTab(); injectFarmConfigActions(); }).observe(document.body, { childList: true, subtree: true, characterData: true });
+    window.addEventListener('hashchange', () => { renameFarmConfigTab(); injectFarmConfigActions(); });
+    setInterval(() => { renameFarmConfigTab(); injectFarmConfigActions(); }, 1000);
   };
   if (document.body) start();
   else document.addEventListener('DOMContentLoaded', start, { once: true });
 }
 
+/** 调 World 的 manage 面板：备份 / 重置。 */
+async function farmManageCall(method) {
+  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;
+}
+
+/** 往宿主的「游戏配置」页里塞「存档与重置」按钮。 */
+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: '农场',
@@ -2700,8 +2785,52 @@ 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 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(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-electron/main.js

@@ -9,6 +9,7 @@ function arg(name, fallback = '') {
 }
 
 const statePath = path.resolve(arg('state-path', path.join(__dirname, '..', 'overlay', 'runtime', 'state.json')));
+const screensPath = path.join(path.dirname(statePath), 'screens.json');
 const assetsDir = path.resolve(arg('assets-dir', path.join(__dirname, '..', 'assets', 'sprites')));
 const logPath = arg('log', '');
 const pidPath = arg('pid', '');
@@ -46,10 +47,34 @@ function checkLease() {
 }
 
 
+function listScreens() {
+  const primary = screen.getPrimaryDisplay();
+  return screen.getAllDisplays().map((d, i) => ({
+    id: String(d.id),
+    label: d.label || ('Display ' + (i + 1)),
+    primary: d.id === primary.id,
+    width: Math.round(d.bounds.width),
+    height: Math.round(d.bounds.height),
+  }));
+}
+
+function writeScreens() {
+  try {
+    fs.mkdirSync(path.dirname(screensPath), { recursive: true });
+    fs.writeFileSync(screensPath, JSON.stringify(listScreens(), null, 2), 'utf8');
+  } catch (e) { log('screens.json failed: ' + e.message); }
+}
+
+function displayFor(st) {
+  const all = screen.getAllDisplays();
+  const id = String(st?.screen ?? '');
+  return all.find((d) => String(d.id) === id) || screen.getPrimaryDisplay();
+}
+
 function bounds() {
   const st = readState() || {};
   const h = Math.min(800, Math.max(120, Number(st.stripHeight) || 320));
-  const wa = screen.getPrimaryDisplay().workArea;
+  const wa = displayFor(st).workArea;
   return { x: Math.round(wa.x), y: Math.round(wa.y + wa.height - h), width: Math.round(wa.width), height: h };
 }
 
@@ -103,21 +128,22 @@ if (!app.requestSingleInstanceLock()) {
   app.on('second-instance', () => { if (win) win.showInactive(); });
   app.whenReady().then(() => {
     writePid();
+    writeScreens();
     createWindow();
-    screen.on('display-metrics-changed', () => {
+    const fit = () => {
       if (!win) return;
       const b = bounds();
-      win.setBounds(b);
-      win.webContents.send('resize');
-    });
+      const cur = win.getBounds();
+      if (cur.x !== b.x || cur.y !== b.y || cur.width !== b.width || cur.height !== b.height) {
+        win.setBounds(b);
+        win.webContents.send('resize');
+      }
+    };
+    for (const event of ['display-added', 'display-removed', 'display-metrics-changed']) {
+      screen.on(event, fit);
+    }
     setInterval(checkLease, 5000);
-    setInterval(() => {
-      if (!win) return;
-      const st = readState() || {};
-      const h = Math.min(800, Math.max(120, Number(st.stripHeight) || 320));
-      const b = bounds();
-      if (win.getBounds().height !== h) { win.setBounds(b); win.webContents.send('resize'); }
-    }, 1000);
+    setInterval(fit, 1000);
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lily-cooperative/custom-farm",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "type": "module",
   "private": false,
   "publishConfig": {

package/src/farm.js

@@ -49,6 +49,8 @@ export const REACH = 0.05;
 export const DEFAULTS = {
   /** 安装目录：overlay / overlay-electron / assets 放在这里；空 = <dataDir>/custom-farm */
   installPath: '',
+  /** 选中的显示器 id；空 = 自动（主屏）。 */
+  screen: '',
   /** 最多同时种几棵（屏幕上不重叠地放得下的上限） */
   maxPlants: 12,
   /** 屏幕逻辑宽度，用来把"像素宽"换算成 x 间距 */
@@ -1074,6 +1076,7 @@ export function overlayView(state) {
     weatherFx: state.weatherFx ?? weatherFxOf(normalizeWeathers(DEFAULT_WEATHERS)[0]),
     current: state.current ?? null,
     currentAt: Number.isFinite(state.standingAt) ? Number(state.standingAt) : null,
+    screen: state.screen ?? '',
     farm: { min: fb.min, max: fb.max, cells: fb.cells, cropScale: fb.cropScale, cropZoom: Number(state.cropScale) || 1 },
     ground: { tile: groundTile },
     waterFx: live.status ? {

package/src/index.js

@@ -3,7 +3,7 @@
  */
 import { CROPS, ROTATION } from './crops.js';
 import { DEFAULTS, overlayView, summary } from './farm.js';
-import { FARM_TOOL_DECLS, FarmWorld } from './world.js';
+import { FARM_TOOL_DECLS, FarmWorld, screenOptions } from './world.js';
 
 const TOOL_SUMMARIES = {
   farm_status: {
@@ -64,7 +64,9 @@ export const farmDefinition = {
     botDir: ctx.botDir,
     packageDir: ctx.packageDir,
     persist: (patch) => ctx.persist(patch),
+    restart: () => ctx.restart(),
   }),
+  configOptions: (kind, language) => (kind === 'farm-screens' ? screenOptions(language) : []),
   describe: {
     tools: describeTools(FARM_TOOL_DECLS),
     events: [

package/src/world.js

@@ -18,7 +18,7 @@
 import { spawn } from 'node:child_process';
 import { cpSync, existsSync, mkdirSync, readFileSync, renameSync, rmSync, symlinkSync, unlinkSync, writeFileSync } from 'node:fs';
 import { execFileSync } from 'node:child_process';
-import { mkdir, readFile, readdir, rename, unlink, writeFile } from 'node:fs/promises';
+import { mkdir, copyFile, readFile, readdir, rename, unlink, writeFile } from 'node:fs/promises';
 import { dirname, join, resolve, sep } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
@@ -73,6 +73,17 @@ import {
 } from './farm.js';
 
 const ENV_PROMPT = fileURLToPath(new URL('./ENV_PROMPT.md', import.meta.url));
+/** Electron 图层写出的显示器列表；配置页的「显示器」下拉用它。 */
+let screenChoices = [];
+
+export function screenOptions(language = 'zh') {
+  const zh = String(language).toLowerCase().startsWith('zh');
+  const out = [{ value: '', label: zh ? '自动（主屏）' : 'Auto (primary)' }];
+  for (const [i, d] of screenChoices.entries()) {
+    out.push({ value: String(d.id), label: String(d.label || (zh ? '显示器 ' : 'Display ') + (i + 1)) + (d.primary ? (zh ? '（主屏）' : ' (primary)') : '') });
+  }
+  return out;
+}
 const msg = (err) => (err instanceof Error ? err.message : String(err));
 
 const pct = (x) => (x === null || x === undefined ? '?' : Math.round(Number(x) * 100));
@@ -297,6 +308,13 @@ function farmConfigGroups(language = 'zh', defaultHomePath = '') {
         description: t('影响之后的操作；startCoins 主要影响新开局。', 'Affects subsequent actions; startCoins mainly affects a fresh game.'),
         properties: {
           'worlds.farm.startCoins': int(t('新开局初始金币', 'Starting coins'), t('默认 120，只影响新开档。', 'Default 120; only affects a new save.'), 0, 100000),
+          'worlds.farm.screen': {
+            type: 'string',
+            title: t('显示器', 'Display'),
+            description: t('图层放在哪块屏幕；「自动」跟随主屏。', 'Which display hosts the overlay; Auto uses the primary display.'),
+            'x-options': 'farm-screens',
+            'x-hot': true,
+          },
           'worlds.farm.overlayEnabled': bool(t('写桌面图层的 state.json', 'Write the overlay state.json'), t('默认开。关掉后桌面农场停止更新。', 'On by default. Off stops the desktop farm from updating.')),
           'worlds.farm.hideFarm': bool(t('隐藏农场', 'Hide farm'), t('勾选后停止桌面图层；农场仍在后台生长，取消勾选恢复。', 'Stop the desktop overlay; the farm keeps growing. Uncheck to show it again.')),
         },
@@ -331,6 +349,7 @@ export class FarmWorld {
     this.botDir = opts.botDir ?? process.cwd();
     this.packageDir = opts.packageDir ?? process.cwd();
     this.persistConfig = typeof opts.persist === 'function' ? opts.persist : null;
+    this.restartWorld = typeof opts.restart === 'function' ? opts.restart : null;
     // 是否由这个 World 管桌面图层的启停（单元测试里传 false，避免碰到真实图层）
     this.manageLayers = opts.manageLayers !== false;
     this.language = 'zh';
@@ -372,6 +391,7 @@ export class FarmWorld {
     const water = this.#catalog?.status?.water ?? null;
     return {
       ...DEFAULTS,
+      screen: String(this.cfg?.screen ?? ''),
       maxPlants: this.#num('maxPlants', 1, 24),
       screenWidth,
       zoom: this.#num('zoom', 1, 8),
@@ -543,6 +563,67 @@ export class FarmWorld {
     this.#ensureLayers('安装路径变更');
   }
 
+  /** 备份存档：把 state.json 和 custom.json 复制到 data/farm/backups/backup-时间/。 */
+  async #backupNow() {
+    const d = new Date();
+    const p2 = (n) => String(n).padStart(2, '0');
+    const stamp = d.getFullYear() + p2(d.getMonth() + 1) + p2(d.getDate()) + '-' + p2(d.getHours()) + p2(d.getMinutes()) + p2(d.getSeconds());
+    const dir = join(this.dataDir, 'farm', 'backups', 'backup-' + stamp);
+    await mkdir(dir, { recursive: true });
+    const files = [];
+    for (const [name, src] of [
+      ['state.json', this.stateFile()],
+      ['custom.json', join(this.dataDir, 'farm', 'custom.json')],
+    ]) {
+      try {
+        if (!existsSync(src)) continue;
+        await copyFile(src, join(dir, name));
+        files.push(name);
+      } catch (err) {
+        this.#host?.log?.warn?.('自定义农场：备份文件失败', { file: src, err: msg(err) });
+      }
+    }
+    this.#host?.log?.info?.('自定义农场：已备份存档', { dir, files });
+    return {
+      ok: true,
+      path: dir,
+      files,
+      text: files.length ? '已备份到 ' + dir : '没有可备份的存档文件；已创建空备份目录 ' + dir,
+    };
+  }
+
+  /** 重置一切：先备份，再删 state.json / custom.json，最后重启 World 重新生成默认目录。 */
+  async #resetAll() {
+    const backup = await this.#backupNow().catch(() => null);
+    // 先断开内存里的 state，World 重启/停止时就不会把旧状态写回去。
+    this.#state = null;
+    for (const file of [this.stateFile(), join(this.dataDir, 'farm', 'custom.json')]) {
+      try { await unlink(file); } catch { /* 文件本来就不存在 */ }
+    }
+    this.#host?.log?.warn?.('自定义农场：已重置全部存档与设置', { backup: backup?.path ?? null });
+    if (this.restartWorld) this.setTimeoutImpl(() => { void this.restartWorld(); }, 300);
+    return {
+      ok: true,
+      backup: backup?.path ?? null,
+      text: '已重置存档和自定义设置' + (backup?.path ? '；备份在 ' + backup.path : '') + '。World 正在重启。',
+    };
+  }
+
+  /** 读取 Electron 图层写出的显示器列表，供游戏配置的「显示器」下拉使用。 */
+  #refreshScreens() {
+    try {
+      const file = join(dirname(this.overlayFile()), 'screens.json');
+      const list = JSON.parse(readFileSync(file, 'utf8'));
+      if (Array.isArray(list) && list.length) {
+        screenChoices = list.map((d) => ({
+          id: String(d.id ?? ''),
+          label: String(d.label ?? ''),
+          primary: Boolean(d.primary),
+        })).filter((d) => d.id);
+      }
+    } catch { /* 图层还没起来，保留上次的列表 */ }
+  }
+
   /** 自定义目录：custom.json + 安装目录下的 assets\sprites。 */
   #createCatalog() {
     const home = this.#homePath();
@@ -1282,7 +1363,9 @@ export class FarmWorld {
         this.#state.dropScale = cfg.dropScale;
         this.#state.groundHeight = cfg.groundHeight;
         this.#state.stripHeight = cfg.stripHeight;
+        this.#state.screen = cfg.screen;
       }
+      this.#refreshScreens();
       await writeJsonAtomic(this.overlayFile(), overlayView(this.#state));
     } catch (err) {
       this.#host?.log?.debug?.('自定义农场：图层状态没写出去', { file: this.overlayFile(), err: msg(err) });
@@ -1482,6 +1565,11 @@ export class FarmWorld {
         { label: '天数', value: started ? '第 ' + s.day + ' 天' : '—', tone: 'plain' },
       ],
       panels: [{
+        id: 'manage',
+        title: '存档与重置',
+        description: '备份存档，或把存档和全部自定义设置重置为默认。',
+        getMethods: ['state'],
+      }, {
         id: 'bag',
         title: '背包',
         description: '背包、农场预览、摆放道具与手动合成；装饰在这里输入坐标放置。',
@@ -1528,6 +1616,12 @@ export class FarmWorld {
   async invoke(panel, method, args = []) {
     return this.#serial(async () => {
       const cfg = this.#cfgAll();
+      if (panel === 'manage') {
+        if (method === 'backup') return this.#backupNow();
+        if (method === 'reset') return this.#resetAll();
+        if (method === 'state') return { ok: true };
+        throw new Error('不认识的存档操作：' + method);
+      }
       if (panel === 'status') return this.#statusInvoke(method, args, cfg);
       if (panel === 'bag') return this.#bagInvoke(method, args);
       if (panel === 'shop') return this.#shopInvoke(method, args);