li-onmyown / Yap

超快的原神自动拾取 Ultra-fast Genshin Impact Auto Pickup

Yap

Yet Another Genshin Impact Pickupper

又一个原神拾取器

Named from Yas

介绍

借鉴了Yas代码实现的自动拾取器。

一个开箱即用、跑的飞快、占用资源极低、可配置黑名单的自动拾取器，解放滚轮和拾取键（还有Y键probably）， Which may be the best open source pickupper in terms of performance, usability and configurability.

视频演示：v0.1.0锄地 v0.1.1捡狗粮 （过于老旧了，目前性能更好）

模型训练：yap-train（detach fork from yas-train）

友情链接：BetterGI--更好的原神（更多有用的功能）

原理

使用基于L*/灰度通道的模板匹配（which is used in other naive pickuppers基于轮廓提取+特征匹配的方案，实现μs级别的拾取键的定位； 通过固定位置关系截取拾取物的文字； 之后，与Yas一样，使用SVTR网络对预处理后的区域图片进行识别；

目前的策略是截取包含拾取键上下两个可能存在的拾取物文字，共五个区域。 然后根据黑白名单，利用硬编码的自上而下拾取算法，生成动作序列ops，再进行执行。

其中黑白名单的逻辑是：白名单中的物品必须拾取，黑名单中的物品若没有在白名单中，则不拾取。

黑名单 = 默认黑名单 + 用户自定义黑名单。 默认黑名单包括了NPC/自机角色、机关/操作/宝箱等探索交互、各种秘境。

整体流程的时序是：

... -> sleep infer_gap ms -> find F key -> infer image -> do pickup -> ...
or // 如果找不到拾取键
... -> sleep infer_gap ms -> find F key -> ...

其中可配置的infer_gap参数为推理间隔，单位ms。

拾取动作序列的时序是：

... F down ->  sleep f_internal ms -> F_up -> sleep f_gap ms -> ...
... scroll -> sleep scroll_gap ms -> ...

其中拾取键和滚轮的三个参数均可配置，分别为f_internal（拾取键摁下后等待时间）、f_gap（拾取键松开后的冷却时间）、scroll_gap（滚轮滚动后的冷却时间），单位ms。

有三个子线程：

1. 用于监听全局快捷键，以暂停/恢复拾取，and other functions。
2. 用于检测进入世界&联机邀请，以自动摁下Y键。
3. 用于生成UID的遮罩

知乎：【原神】基于文字识别的超快自动拾取（有点老了，还是模板匹配做k键定位）

使用

目前支持windows，PC客户端（已支持云原神），16:9分辨率。

16:10分辨率拾取处于测试阶段（作者没有硬件来测试），可能会有bug。

全局快捷键见下表：

快捷键	功能
Alt + 0	暂停。切换是否拾取
Alt + z	切换是否使用单区域模式，便于拾取单个物品，默认关闭

隐藏功能见：other_funcs.md

从release获取

目前有两种release，一种是由github actions自动构建的nightly版本，一种是手动构建的release版本。前者可能会有bug，后者较为稳定。

PS：可以使用nightly版本帮助debug。

1. 点击此处下载release压缩包，解压获得yap.exe应用。

2. 如果使用过旧版本，路径下有black_lists.json, white_lists.json，Yap会自动合并为config.json，并删去默认黑名单中存在的交互/物品名称； 如果是第一次使用，Yap也会自动生成一个空白的config.json。

3. 使用记事本/VSCode等编辑器打开config.json，添加需要拉黑 or 必须交互/拾取的名称，注意需要使用英文符号，如：

{
  "black_list": [
    "史莱姆凝液",
    "薄荷",
    "甜甜花",
    "树莓"
  ],
  "white_list": [
    "芙萝拉",
    "调查",
    "薄荷",
    "甜甜花",
    "树莓",
    "传送锚点"
  ]
}

3. 可选: 使用config.json配置拾取参数、拾取键以及余弦匹配阈值，如：

{
  "black_list": [
    "史莱姆凝液",
    "薄荷",
    "甜甜花",
    "树莓"
  ],
  "white_list": [
    "芙萝拉",
    "调查",
    "薄荷",
    "甜甜花",
    "树莓",
    "传送锚点"
  ],
  "click_tp": false,
  "f_gap": 85,
  "f_internal": 50,
  "infer_gap": 0,
  "scroll_gap": 70,
  "pick_key": "f",
  "cos_thre": 0.9977
}

3. 右键yap.exe选择以管理员身份运行

4. 性能调优（如果你会使用命令行/json设置参数的话）

自行编译

1. 编译

cargo build --release

2. 配置config.json

3. 管理员运行/管理员身份打开终端运行

yap> ./target/release/yap.exe 

or

yap> cargo run --release

4. 如果需要进行debug调试，可参考命令行参数：

/yap --help
YAP - 原神自动拾取器 0.2.1
Alex-Beng <[e-mail]>
Genshin Impact Pickup Helper

USAGE:
    yap.exe [FLAGS] [OPTIONS] [ARGS]

FLAGS:
    -h, --help         Prints help information
        --no-pickup    不执行拾取，仅info拾取动作，debug专用
    -V, --version      Prints version information

OPTIONS:
    -c, --channal <channal>        灰度化时使用的通道，默认使用gray通道，另一个可选值为L* [default: gray]
        --dump <dump>              输出模型预测结果、原始图像至指定的文件夹，debug专用
    -i, --dump-idx <dump_idx>      执行dump时，输出结果起始的index [default: 0]
    -g, --infer-gap <infer_gap>    一次检测推理拾取的间隔，单位ms [default: 0]
        --log <log>                日志等级，可选值为trace, debug, info, warn, error [default: warn]
        --pick-key <pick_key>      拾取案件，正常人默认为F [default: f]

ARGS:
    <hotkey>      是否注册hotkey用于调整拾取时序，debug专用
    <click_tp>    是否自动点击传送

Just enjoy it!