快速开始

注意: 本文档是关于如何使用 NodeJS 进行集成

安装

需要 NodeJS 20 及以上, 创建项目文件夹后通过下列命令安装

npm install @maaxyz/maa-node

由于 npm 包中集成了 MaaFramework 的库以及 AgentBinary, 下载可能会花费一点时间.

准备资源

参考 准备资源文件

连接, 执行任务

对于一个最直接的流程而言, 我们需要执行以下步骤:

• 扫描设备
• 创建控制器并连接
• 创建资源并加载
• 创建实例并绑定
• 执行任务

import * as maa from "./maa";

console.log(maa.Global.version);

async function main() {
  // 查询所有Adb设备
  const devices = await maa.AdbController.find();
  if (!devices) {
    return;
  }

  // 使用第一个设备创建控制器
  const [name, adb_path, address, screencap_methods, input_methods, config] =
    devices[0];
  const ctrl = new maa.AdbController(
    adb_path,
    address,
    screencap_methods,
    input_methods,
    config
  );
  ctrl.notify = (msg, detail) => {
    console.log(msg, detail);
  };
  // 连接设备
  await ctrl.post_connection();

  // 创建资源
  const res = new maa.Resource();
  res.notify = (msg, detail) => {
    console.log(msg, detail);
  };
  // 加载资源
  await res.post_bundle("./resource");

  // 创建实例
  const tskr = new maa.Tasker();
  tskr.notify = (msg, detail) => {
    console.log(msg, detail);
  };

  // 绑定控制器和资源
  tskr.bind(ctrl);
  tskr.bind(res);

  // 检查是否正确创建
  console.log(tskr.inited);

  // 执行任务, Task1定义在pipeline/Task.json
  if (await tskr.post_task("Task1").wait().success) {
    console.log("success!");
  }
}

main();

在 JS 侧影响资源行为

注意执行任务的这段代码await tskr.post_task('task', 'Task1').wait()

post函数可以传入第三个参数, 该参数是一个对象, 其结构和pipeline下的 json 完全一致, 会覆盖在原有的pipeline之上. 因此, 可以通过在此处传入一个对象来实现控制任务(甚至创建新的任务).

// 通过第三个参数, 创建了一个新的任务Task2, 然后执行它
// 此处创建的任务仅在当前执行中有效
await tskr
  .post_task("Task2", {
    Task2: {
      next: ["Task1"],
    },
  })
  .wait();

接下来

请参考其它文档, 编写资源