@weinibuliu/maa-debugger 0.0.0-nightly.4.1.b8fb7d2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MaaXYZ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# MaaDebugger
+
+由 MaaXYZ 团队开发与维护的 MaaFramework 调试器，拥有现代的 WebUI 和即时的任务反馈。
+
+Official desktop debugger for MaaFramework, featuring a web-based UI and real-time task inspection.
+
+## 安装方式
+
+### 使用 npm (Node.js)
+
+MaaDebugger 以 `maa-debugger` 的名称发布于 [npm](https://www.npmjs.com) 。你可以使用 npm 或其他包管理器(如 pnpm)安装、管理与使用。这里仅介绍 npm 用法。
+
+```bash
+# 全局安装
+npm i -g maa-debugger
+maa-debugger
+# 非全局安装
+npx maa-debugger
+```
+
+MaaDebugger 支持命令行参数，你可以通过 `--help` / `-H` 命令来获取帮助。
+
+```bash
+npx maa-debugger --help
+```
+
+### 使用 pip (Python)
+
+MaaDebugger
+将以 `MaaDebugger` 的名称发布于 [PyPI](https://pypi.org/project/MaaDebugger) 。你可以使用 pip 或其他包管理器(如 uv)安装、管理与使用。
+>[!WARNING]
+在早期开发阶段，我们**不会**发布至 PyPI，请自行使用其他渠道。
+
+### 自行下载
+
+我们也提供了 [Github Release](https://github.com/MaaXYZ/MaaDebugger/releases) 下载渠道，下载解压后即可使用。
+>[!WARNING]
+在早期开发阶段，我们**不会**提供 Release，而是仅在 [Actions](https://github.com/MaaXYZ/MaaDebugger/actions/workflows/publish.yml) 上传产物，请自行前往下载。
+
+## 开发模式
+
+在开发阶段需要同时启动**后端**和**前端**两个终端：
+
+### Terminal 1: 后端 (Go Service)
+
+```bash
+cd server
+air # 支持热重载
+```
+
+### Terminal 2: 前端 (Web)
+
+```bash
+cd web
+pnpm i   # 首次需要安装依赖
+pnpm dev        # 启动前端 (http://localhost:5173)
+```
+
+然后打开浏览器访问 **<http://localhost:5173>** 即可。
+
+前端会自动将 `/api` 和 `/ws` 请求代理到后端 `http://127.0.0.1:8011`。
+
+## 生产构建
+
+一键构建前端并嵌入到 Go 二进制文件中，最终产物为单个可执行文件：
+
+```bash
+node build.mjs                     # 构建当前平台
+node build.mjs --os linux          # 交叉编译 Linux
+node build.mjs --os windows        # 交叉编译 Windows
+node build.mjs --os darwin         # 交叉编译 macOS
+node build.mjs --skip-frontend     # 跳过前端构建（仅编译 Go）
+```
+
+构建完成后，启动 `./MaaDebugger`（Windows 下为 `MaaDebugger.exe`），程序会自动选择可用端口（默认从 8011 开始）并打开浏览器。
+
+> [!NOTE]
+> 需要注意的是 `MaaDebugger` 将寻找 `./bin` 下的 MaaFramework 动态库。
+
+## 环境变量
+
+TODO
+
+## 技术栈
+
+| 层 | 技术 |
+|----|------|
+| 前端 | Vue 3 + Nuxt UI 4 + Pinia + Vite 7 + TypeScript |
+| 后端 | Go + net/http + gorilla/websocket + zerolog |
+| MaaFW | maa-framework-go (CGO binding) |
+| 通信 | REST API + WebSocket |
+| 嵌入 | Go `embed` (前端编译产物嵌入到 Go 二进制) |

package/index.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+
+const { spawn } = require("node:child_process");
+const { existsSync } = require("node:fs");
+const path = require("node:path");
+
+const platformPackageName = `@weinibuliu/maa-debugger-${process.platform}-${process.arch}`;
+
+let platformPackageRoot;
+try {
+  platformPackageRoot = path.dirname(
+    require.resolve(`${platformPackageName}/package.json`),
+  );
+} catch (error) {
+  console.error(
+    `[maa-debugger] Missing platform package: ${platformPackageName}`,
+  );
+  console.error(
+    `[maa-debugger] Reinstall the package on ${process.platform}-${process.arch} or choose a supported platform.`,
+  );
+  process.exit(1);
+}
+
+const isWindows = process.platform === "win32";
+const executableName = `MaaDebugger${isWindows ? ".exe" : ""}`;
+const exePath = path.join(platformPackageRoot, executableName);
+if (!existsSync(exePath)) {
+  console.error(`[maa-debugger] Missing executable: ${exePath}`);
+  console.error(
+    `[maa-debugger] Expected binary name for current platform: ${executableName}`,
+  );
+  process.exit(1);
+}
+
+const nodePath = path.resolve(require.resolve("@maaxyz/maa-node"), "../../../");
+const channelPath = path.join(
+  nodePath,
+  `maa-node-${process.platform}-${process.arch}`,
+);
+
+const child = spawn(exePath, process.argv.slice(2), {
+  stdio: "inherit",
+  env: {
+    ...process.env,
+    MAADBG_CHANNEL: "npm",
+    MAADBG_CHANNEL_PATH: channelPath,
+  },
+});
+
+child.on("exit", (code, signal) => {
+  if (signal) {
+    process.kill(process.pid, signal);
+    return;
+  }
+  process.exit(code ?? 0);
+});
+
+child.on("error", (err) => {
+  console.error(`[maa-debugger] Failed to start ${executableName}:`, err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@weinibuliu/maa-debugger",
+  "version": "0.0.0-nightly.4.1.b8fb7d2",
+  "description": "Official desktop debugger for MaaFramework, with integrated web UI and real-time task inspection.",
+  "bin": {
+    "maa-debugger": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@maaxyz/maa-node": "5.8.0-beta.1"
+  },
+  "optionalDependencies": {
+    "@weinibuliu/maa-debugger-win32-x64": "0.0.0-nightly.4.1.b8fb7d2",
+    "@weinibuliu/maa-debugger-win32-arm64": "0.0.0-nightly.4.1.b8fb7d2",
+    "@weinibuliu/maa-debugger-linux-x64": "0.0.0-nightly.4.1.b8fb7d2",
+    "@weinibuliu/maa-debugger-linux-arm64": "0.0.0-nightly.4.1.b8fb7d2",
+    "@weinibuliu/maa-debugger-darwin-x64": "0.0.0-nightly.4.1.b8fb7d2",
+    "@weinibuliu/maa-debugger-darwin-arm64": "0.0.0-nightly.4.1.b8fb7d2"
+  },
+  "repository": {
+    "type": "github",
+    "url": "git+https://github.com/MaaXYZ/MaaDebugger.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "tag": "nightly"
+  },
+  "keywords": [
+    "maaframework",
+    "maa",
+    "debugger",
+    "automation",
+    "desktop"
+  ],
+  "author": "MaaXYZ",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MaaXYZ/MaaDebugger/issues"
+  },
+  "homepage": "https://github.com/MaaXYZ/MaaDebugger"
+}