openclaw-plugin-grinders-farm 0.3.0 → 0.3.1

package/README.md

@@ -1,35 +1,54 @@
 # openclaw-plugin-grinders-farm
 
-OpenClaw plugin for Grinder's Farm. Registers:
+`Grinder's Farm` 的 OpenClaw 插件。  
+安装后你可以直接在聊天里使用 `/farm ...` 命令游玩，并开启自动推进与多频道推送。
 
-- `/farm` command
-- `grinders_farm` tool (for skill `command-dispatch: tool`)
-
-## Install (End User)
+## 安装
 
 ```bash
 openclaw plugins install openclaw-plugin-grinders-farm --dangerously-force-unsafe-install
 ```
 
-No local repo clone or build is required for end users.
+安装完成后，确认已加载：
 
-## Runtime Resolution
+```bash
+openclaw plugins inspect grinders-farm
+```
 
-The plugin tries these options in order:
+## 使用流程（推荐）
 
-1. `GRINDERS_FARM_ROOT` env
-2. plugin config `gameRoot`
-3. parent directory of this plugin
-4. `grinders-farm` CLI in `PATH` (or `GRINDERS_FARM_CLI_BIN`)
+1. 在目标频道发送一次：
+
+```text
+/farm farm
+```
 
-If `gameRoot` is available, plugin can auto-start:
+2. 开始自动推进：
 
-- local image server (`imageServerPort`)
-- local auto worker (fixed 20s/day)
+```text
+/farm start
+```
+
+3. 停止自动推进：
+
+```text
+/farm stop
+```
 
-If only CLI mode is available, plugin still works and can auto-run `grinders-farm start`.
+说明：
 
-## Minimal OpenClaw Config
+- `start` 固定每 20 秒推进一天
+- 会自动推送到所有已绑定频道（先发送过 `/farm ...` 的频道）
+
+## 常用配置
+
+你可以在 OpenClaw 的 plugin 配置里设置：
+
+- `autoStartWorkerOnGatewayBoot`：Gateway 启动时是否自动启动推进
+- `imageServerPort`：本地农场图片服务端口
+- `gameRoot`：当自动定位失败时，手动指定项目根目录
+
+最小配置示例：
 
 ```json
 {
@@ -47,18 +66,27 @@ If only CLI mode is available, plugin still works and can auto-run `grinders-far
 }
 ```
 
-Optional if auto-detection fails:
+## 常见问题
 
-```json
-{
-  "plugins": {
-    "entries": {
-      "grinders-farm": {
-        "config": {
-          "gameRoot": "/path/to/grinders-farm"
-        }
-      }
-    }
-  }
-}
+### 插件已安装但命令不可用
+
+先检查：
+
+```bash
+openclaw plugins inspect grinders-farm
 ```
+
+如果不是 `loaded`，重启 Gateway 后再试。
+
+### 自动推送没有发到某个频道
+
+在该频道先执行一次 `/farm farm` 完成绑定，再执行 `/farm start`。
+
+### 找不到 `grinders-farm` 可执行文件
+
+可设置环境变量：
+
+- `GRINDERS_FARM_ROOT`
+- `GRINDERS_FARM_CLI_BIN`
+
+然后重启 Gateway。

package/dist/index.js

@@ -11,6 +11,7 @@ const FARM_IMAGE_PATH = path.join(os.homedir(), ".grinders-farm", "farm.png");
 const OPENCLAW_MEDIA_DIR = path.join(os.homedir(), ".openclaw", "media", "grinders-farm");
 const ONESHOT_RELATIVE_PATH = path.join("src", "adapters", "oneshot.ts");
 const DEFAULT_START_INTERVAL_SEC = 20;
+const ONESHOT_TIMEOUT_MS = 15_000;
 function resolveGameRoot(api) {
     const raw = api.pluginConfig;
     const fromEnv = process.env.GRINDERS_FARM_ROOT?.trim();
@@ -25,16 +26,42 @@ function isValidGameRoot(candidate) {
 }
 function resolveClawFarmCliBin() {
     const fromEnv = process.env.GRINDERS_FARM_CLI_BIN?.trim();
-    if (fromEnv)
-        return fromEnv;
+    if (fromEnv) {
+        if (fromEnv.endsWith("/dist/src/adapters/terminal.js")) {
+            const oneshotJs = fromEnv.replace(/terminal\.js$/, "oneshot.js");
+            if (fs.existsSync(oneshotJs)) {
+                return { bin: process.execPath, binArgsPrefix: [oneshotJs] };
+            }
+            return null;
+        }
+        return fromEnv.endsWith(".js") ? { bin: process.execPath, binArgsPrefix: [fromEnv] } : { bin: fromEnv, binArgsPrefix: [] };
+    }
     try {
+        const oneshotWhich = spawnSync("sh", ["-lc", "command -v grinders-farm-oneshot"], {
+            encoding: "utf8",
+            maxBuffer: 1024 * 1024,
+        });
+        const oneshotOut = (oneshotWhich.stdout ?? "").trim();
+        if (oneshotOut)
+            return { bin: oneshotOut, binArgsPrefix: [] };
         const which = spawnSync("sh", ["-lc", "command -v grinders-farm"], {
             encoding: "utf8",
             maxBuffer: 1024 * 1024,
         });
         const out = (which.stdout ?? "").trim();
-        if (out)
-            return out;
+        if (out) {
+            if (out.endsWith("/dist/src/adapters/terminal.js")) {
+                const oneshotJs = out.replace(/terminal\.js$/, "oneshot.js");
+                if (fs.existsSync(oneshotJs)) {
+                    return { bin: process.execPath, binArgsPrefix: [oneshotJs] };
+                }
+                return null;
+            }
+            if (out.endsWith(".js")) {
+                return { bin: process.execPath, binArgsPrefix: [out] };
+            }
+            return { bin: out, binArgsPrefix: [] };
+        }
     }
     catch {
         // ignore
@@ -48,7 +75,7 @@ function resolveRuntimeMode(api) {
     }
     const bin = resolveClawFarmCliBin();
     if (bin) {
-        return { kind: "cli-bin", bin };
+        return { kind: "cli-bin", bin: bin.bin, binArgsPrefix: bin.binArgsPrefix };
     }
     return null;
 }
@@ -61,29 +88,43 @@ function getPluginTiming(api) {
 function runOneshot(mode, argsLine) {
     const argv = argsLine.trim().length > 0 ? argsLine.trim().split(/\s+/) : ["farm"];
     const resolvedOpenclawBin = resolveOpenclawBin();
+    const env = {
+        ...process.env,
+        OPENCLAW_BIN: process.env.OPENCLAW_BIN?.trim() || resolvedOpenclawBin,
+    };
     const result = mode.kind === "repo-tsx"
         ? spawnSync("npx", ["tsx", path.join(mode.gameRoot, ONESHOT_RELATIVE_PATH), ...argv], {
             cwd: mode.gameRoot,
             encoding: "utf8",
             maxBuffer: 8 * 1024 * 1024,
-            env: {
-                ...process.env,
-                OPENCLAW_BIN: process.env.OPENCLAW_BIN?.trim() || resolvedOpenclawBin,
-            },
+            timeout: ONESHOT_TIMEOUT_MS,
+            env,
         })
-        : spawnSync(mode.bin, argv, {
+        : spawnSync(mode.bin, [...mode.binArgsPrefix, ...argv], {
             encoding: "utf8",
             maxBuffer: 8 * 1024 * 1024,
-            env: {
-                ...process.env,
-                OPENCLAW_BIN: process.env.OPENCLAW_BIN?.trim() || resolvedOpenclawBin,
-            },
+            timeout: ONESHOT_TIMEOUT_MS,
+            env,
         });
-    const stderr = result.stderr?.trim() ?? "";
-    const stdout = result.stdout?.trim() ?? "";
+    const finalResult = result.error && result.error.code === "ENOEXEC"
+        ? spawnSync(process.execPath, [mode.kind === "cli-bin" ? mode.bin : "", ...(mode.kind === "cli-bin" ? mode.binArgsPrefix : []), ...argv].filter(Boolean), {
+            encoding: "utf8",
+            maxBuffer: 8 * 1024 * 1024,
+            timeout: ONESHOT_TIMEOUT_MS,
+            env,
+        })
+        : result;
+    const stderr = finalResult.stderr?.trim() ?? "";
+    const stdout = finalResult.stdout?.trim() ?? "";
     const combined = [stdout, stderr].filter(Boolean).join("\n");
-    const code = result.status ?? (result.error ? 1 : 0);
-    return { text: combined || (result.error ? String(result.error.message) : "(no output)"), exitCode: code };
+    const code = finalResult.status ?? (finalResult.error ? 1 : 0);
+    if (finalResult.error && finalResult.error.code === "ETIMEDOUT") {
+        return {
+            text: "grinders-farm 命令执行超时。请确认你安装的是支持 oneshot 的新版 grinders-farm（含 grinders-farm-oneshot），或在插件 config 里设置 gameRoot 指向源码仓库。",
+            exitCode: 1,
+        };
+    }
+    return { text: combined || (finalResult.error ? String(finalResult.error.message) : "(no output)"), exitCode: code };
 }
 function isTelegramChannel(ctx) {
     const surface = (ctx.channel ?? ctx.channelId ?? "").toString().trim().toLowerCase();
@@ -247,7 +288,7 @@ function createFarmTool(mode) {
 const plugin = {
     id: "grinders-farm",
     name: "Grinder's Farm",
-    description: "Local grinders-farm subprocess only; no LLM in the game path.",
+    description: "Local grinders-farm subprocess for farm commands and push.",
     register(api) {
         const runtime = resolveRuntimeMode(api);
         if (!runtime) {
@@ -257,7 +298,7 @@ const plugin = {
         api.registerTool(createFarmTool(runtime));
         api.registerCommand({
             name: "farm",
-            description: "Grinder's Farm — run a game command without invoking the model (fast path). Binds this chat for farm push.",
+            description: "Grinder's Farm — run a game command and bind this chat for farm push.",
             acceptsArgs: true,
             handler: async (ctx) => {
                 const bound = await bindDeliveryFromPluginCommand(ctx);

package/openclaw.plugin.json

@@ -1,7 +1,7 @@
 {
   "id": "grinders-farm",
   "name": "Grinder's Farm",
-  "description": "Local grinders-farm plugin: /farm and grinders_farm run deterministic local game logic (no LLM, no remote backend).",
+  "description": "Local grinders-farm plugin: /farm command and grinders_farm tool with local game state and push.",
   "configSchema": {
     "type": "object",
     "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openclaw-plugin-grinders-farm",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "private": false,
   "type": "module",
   "description": "OpenClaw plugin for Grinder's Farm: deterministic /farm command and grinders_farm tool.",
@@ -24,6 +24,8 @@
     "openclaw": ">=2026.1.0"
   },
   "openclaw": {
-    "extensions": ["./dist/index.js"]
+    "extensions": [
+      "./dist/index.js"
+    ]
   }
 }