@bettergi/utils v0.0.5

本项目是一个为Better Genshin Impact 设计的 JavaScript 开发工具函数，旨在帮助开发者简化代码。

安装

npm install @bettergi/utils

函数清单

图文识别

对 RecognitionObject 代码的封装，对于简单的找图、找字操作，不再需要编写复杂的代码。

import {
  findImage,
  findImageInDirection,
  findImageWithinBounds,
  findText,
  findTextInDirection,
  findTextWithinBounds
} from "@bettergi/utils";

// 在整个画面内搜索图片，找不到返回 undefined
const i1 = findImage("assets/关闭.png");

// 在指定方向上搜索图片，找不到返回 undefined
const i2 = findImageInDirection("assets/关闭.png", "north-east");

// 在指定区域内搜索图片，找不到返回 undefined
const i3 = findImageWithinBounds("assets/关闭.png", 960, 0, 960, 1080);

// 在整个画面内搜索文本（不包含、忽略大小写），找不到返回 undefined
const t1 = findText("购买", false, true);

// 在指定方向上搜索文本（包含、忽略大小写），找不到返回 undefined
const t2 = findTextInDirection("师傅", true, true, "east");

// 在指定区域内搜索文本（不包含、忽略大小写），找不到返回 undefined
const t3 = findTextWithinBounds("确认", false, true, 960, 540, 960, 540);

行为流程

对脚本开发过程中常见工作流的抽象，例如：等待 XXX 完成/出现/消失。

import { findImageInDirection, waitUntil } from "@bettergi/utils";

// 等待直到找不到[关闭按钮] 或 5秒后超时，每隔1秒检查一次，期间按 Esc 键
const done = await waitUntil(
  () => findImageInDirection("assets/关闭.png", "north-east") === undefined,
  5000,
  1000,
  () => keyPress("ESCAPE")
);
if (!done) throw new Error("关闭页面超时");

鼠标操作

对常见鼠标操作的封装，如鼠标滚动、拖拽等。

import {
  mouseScrollDown,
  mouseScrollDownLines,
  mouseScrollUp,
  mouseScrollUpLines,
  mouseSlide,
  mouseSlideX,
  mouseSlideY
} from "@bettergi/utils";

// 鼠标滚轮向上滚动 175 像素
await mouseScrollUp(175);

// 鼠标滚轮向下滚动 175 像素
await mouseScrollDown(175);

// 鼠标滚轮向上滚动 99 行，行高 175（默认：背包物品行高）
await mouseScrollUpLines(99);

// 鼠标滚轮向下滚动 1 行，行高 115（自定义：商店物品行高）
await mouseScrollDownLines(1, 115);

// 鼠标从 (745, 610) 拖拽到 (1280, 610)
await mouseSlide(745, 610, 1280, 610);

// 鼠标从 (745, 610) 向右拖拽 435 像素
await mouseSlideX(745, 610, 435);

// 鼠标从 (1290, 140) 向下拖拽 175 像素
await mouseSlideY(1290, 140, 175);

数据存储

对象数据持久化，通过 Proxy 实现自动存储。从而可以无感知地读取/更新数据，而无需考虑如何持久化。

import { useStore } from "@bettergi/utils";

// 创建/读取存储对象，保存到存储文件 store/state.json 中
const state = useStore<{ lastUsedTime?: number; count: number }>("state");
if (state?.lastUsedTime) {
  log.info(`欢迎回来！上次使用时间：${state.lastUsedTime}，计数器已累计至：${state.count}`);
}
try {
  // 模拟脚本运行期间状态的变化
  for (let i = 0; i < Math.floor(Math.random() * 100); i++) {
    state.count = (state.count || 0) + 1; // 自动同步保存到文件
  }
} finally {
  state.lastUsedTime = Date.now(); // 自动同步保存到文件
}