Skip to content

Latest commit

 

History

History
295 lines (223 loc) · 11 KB

README_zh.md

File metadata and controls

295 lines (223 loc) · 11 KB
Raw

logo

Arkntools - Depot Recognition

明日方舟工具箱使用的仓库识别模块

NPM version GitHub license GitHub Workflow Status Feedback

安装

# npm
npm i @arkntools/depot-recognition
# yarn
yarn add @arkntools/depot-recognition

使用

初始化需要提供材料图片的压缩包和材料在仓库中的排序顺序，材料的命名必须为材料 ID

对材料图片有一定要求，需要解包图，允许适当缩放或压缩，可以直接使用下方代码示例给出的资源或自行从 yuanyan3060/Arknights-Bot-Resource 等解包资源库获取

资源形式示例

Node

const axios = require('axios').default;
const { sortBy } = require('lodash');
const {
  DeportRecognizer,
  isTrustedResult,
  toSimpleTrustedResult,
} = require('@arkntools/depot-recognition');

// 你可以自行实现缓存逻辑
const getResources = async () => {
  const {
    data: { mapMd5 },
  } = await axios.get('https://data-cf.arkntools.app/check.json');
  const { data: fileMap } = await axios.get(`https://data-cf.arkntools.app/map.${mapMd5}.json`);

  const { data: item } = await axios.get(`https://data-cf.arkntools.app/data/item.${fileMap['data/item.json']}.json`);
  const { data: pkg } = await axios.get(`https://data-cf.arkntools.app/pkg/item.${fileMap['pkg/item.zip']}.zip`, {
    responseType: 'arraybuffer',
  });

  const getSortId = id => item[id].sortId.cn; // cn us jp kr
  const order = sortBy(Object.keys(item).filter(getSortId), getSortId);

  return { order, pkg };
};

(async () => {
 const dr = new DeportRecognizer(await getResources());
  const { data } = await dr.recognize(
    'https://github.com/arkntools/depot-recognition/raw/main/test/cases/cn_iphone12_0/image.png'
  );
  console.log(data.filter(isTrustedResult)); // 详细的置信度高的结果：包含切图坐标、与其它材料比较的相似度等
  console.log(toSimpleTrustedResult(data)); // 简单的置信度高的结果：{ 材料ID: 数量 }
})();

Web worker

需要 comlink-loader

import DepotRecognitionWorker from 'comlink-loader!@arkntools/depot-recognition/worker';
import { isTrustedResult, toSimpleTrustedResult } from '@arkntools/depot-recognition/tools';
import { transfer } from 'comlink';
import { sortBy } from 'lodash';

// 你可以自行实现缓存逻辑
const getResources = async () => {
  const fetchJSON = url => fetch(url).then(r => r.json());

  const { mapMd5 } = await fetchJSON('https://data-cf.arkntools.app/check.json');
  const fileMap = await fetchJSON(`https://data-cf.arkntools.app/map.${mapMd5}.json`);

  const item = await fetchJSON(`https://data-cf.arkntools.app/data/item.${fileMap['data/item.json']}.json`);
  const pkg = await fetch(`https://data-cf.arkntools.app/pkg/item.${fileMap['pkg/item.zip']}.zip`).then(r =>
    r.arrayBuffer()
  );

  const getSortId = id => item[id].sortId.cn; // cn us jp kr
  const order = sortBy(Object.keys(item).filter(getSortId), getSortId);

  return { order, pkg };
};

const initRecognizer = async () => {
  const { order, pkg } = await getResources();
  const worker = new DepotRecognitionWorker();
  return await new worker.DeportRecognizer(transfer({ order, pkg }, [pkg]));
};

(async () => {
  const dr = await initRecognizer();
  const { data } = await dr.recognize(
    'https://github.com/arkntools/depot-recognition/raw/main/test/cases/cn_iphone12_0/image.png' // 可以是 Blob URL
  );
  console.log(data.filter(isTrustedResult)); // 详细的置信度高的结果：包含切图坐标、与其它材料比较的相似度等
  console.log(toSimpleTrustedResult(data)); // 简单的置信度高的结果：{ 材料ID: 数量 }
})();

本库提供了数种导入方式：

  • @arkntools/depot-recognition/worker
    基本导入方式
  • @arkntools/depot-recognition/worker/index.importScriptsJsDelivr
    所有依赖从 fastly.jsdelivr.net 加载
  • @arkntools/depot-recognition/worker/index.noImportScripts
    无依赖加载，需要自行添加 importScripts

Typescript

如果在 Typescript 中使用 comlink-loader，你需要自行补充模块定义

declare module 'comlink-loader*!@arkntools/depot-recognition/worker' {
  import DepotRecognitionWorker from '@arkntools/depot-recognition/worker/comlinkLoader';
  export * from '@arkntools/depot-recognition/worker/comlinkLoader';
  export default DepotRecognitionWorker;
}

然后你就可以正常导入使用了

import DepotRecognitionWorker, { RemoteDeportRecognizer } from 'comlink-loader!@arkntools/depot-recognition/worker';

let recognizer: RemoteDeportRecognizer | undefined;

(async () => {
  const worker = new DepotRecognitionWorker();
  recognizer = await new worker.DeportRecognizer(/* ... */);
})();

API

DeportRecognizer(config)

new DeportRecognizer(config)

Parameters

Name Type Description
config RecognizerConfig 初始化配置
RecognizerConfig
Name Type Description
order string[] 材料 ID 数组，表示材料在仓库中的排序顺序
pkg any 材料图片的压缩包，是 JSZip.loadAsync 可接受的一个参数或参数的数组
preload boolean 从 pkg 预加载资源

DeportRecognizer.recognize(file, onProgress): Object

识别仓库图片

Parameters

Name Type Description
file string | Buffer 图片地址或 buffer，可以是 Blob URL
onProgress Function 一个会在识别进度更新时被执行的回调，回调参数为进度 number，从 0 开始

Returns

Name Type Description
data RecognizeResult[] 识别相似度结果的数组
debug string[] 使用 setDebug 设置调试模式后会输出一些 base64 形式的过程图片
RecognizeResult
interface RecognizeResult {
  debug: {
    /** 材料切图被缩放到 60*60 时的缩放比例 */
    scale: number;
  };
  /** 材料位置 */
  pos: {
    /** 左上顶点 x */
    x: number;
    /** 左上顶点 y */
    y: number;
    /** 边长 */
    l: number;
    /** 行 */
    row: number;
    /** 列 */
    col: number;
  };
  /** 材料四边与全图四边的距离比例，0~1 */
  view: {
    left: number;
    right: number;
    top: number;
    bottom: number;
  };
  /** 相似度信息 */
  sim?: {
    /** 最相似的材料ID */
    name: string;
    /** 与其相比的差异度，0~1 */
    diff: number;
    /** 该材料的对比记录 */
    diffs: Array<
      [
        /** 材料ID */
        string,
        /** 差异度 */
        number
      ]
    >;
    /** 是否有过于接近的相似度，应当小心甄别识别结果 */
    diffsTooClose: boolean;
  };
  /** 材料数量信息 */
  num?: {
    /** 处理后的数字图片，base64 */
    img: string;
    /** 识别结果，可能含有空格( )或下划线(_)等非数字字符 */
    text: string;
    /** 去除非数字字符后的数字结果，若没识别出数字则默认为 1 */
    value: number;
    /** 排除空格影响后识别结果(text)是否与识别数字(value)不一致 */
    warn: boolean;
  };
}

DeportRecognizer.setDebug(enable): void

设置调试模式

Parameters

Name Type Description
enable boolean 设置为调试模式，识别时会额外输出一些过程图片

DeportRecognizer.setOrder(order): void

设置材料顺序

Parameters

Name Type Description
order string[] 材料 ID 数组，表示材料在仓库中的排序顺序

DeportRecognizer.preloadResource(): void

从 RecognizerConfig.pkg 预加载资源

isTrustedResult(result): boolean

判定一个相似度结果是否可信

Parameters

Name Type Description
result SimilarityResult 识别相似度结果

toSimpleTrustedResult(data): Record<string, number>

将相似度结果数组转化为简单的结果对象

Parameters

Name Type Description
data RecognizeResult[] 识别相似度结果数组

Returns

Name Type Description
[RecognizeResult.sim.name] number 材料ID: 数量