Skip to content

Latest commit

 

History

History
171 lines (115 loc) · 10.9 KB

README.md

File metadata and controls

171 lines (115 loc) · 10.9 KB

Atlas

Atlas是一个适用于V3版本及以上Yunzai-Bot的图鉴查询插件,可通过Yunzai-Bot查询游戏图鉴,插件代码严格遵循ES6规范。

【注意】本项目的所有反馈渠道仅受理Atlas应用端相关问题,且仅保证能在Miao-Yunzai、TRSS-Yunzai及原版V3-Yunzai项目上装载,如何在Yunzai-Bot的其它衍生项目上使用以及机器人协议段问题均不受理,请自行解决或PR。

【另注】开发者已经将近一年没有更新过本插件的主要代码了,仅针对资源仓库在维护,主仓库任何新增功能等建议均存在忽视等风险。

当前支持图鉴库

【已完成】原神图鉴库:Genshin-Atlas

【已完成】崩坏:星穹铁道图鉴库:star-rail-atlas

【持续更新】绝区零图鉴库:zzz-atlas

如何获取

一、下载插件本体

在Yunzai-Bot根目录下,运行cmd,输入以下指令即可从Github(代码托管平台)获取插件

git clone --depth=1 https://github.com/Nwflower/atlas ./plugins/Atlas/

如果服务器布设在国内或者其他未知因素,上述链接访问速度可能较慢。

此时建议使用Gitee镜像源,对应cmd指令如下

git clone --depth=1 https://gitee.com/Nwflower/atlas ./plugins/Atlas/

你也可以使用时雨一键脚本获取本插件,可使用的一键脚本有很多,此处不再赘述。

二、获取图片资源

安装插件后,发送#图鉴升级获取图鉴图片即可正常使用。

如果升级失败了,需要手动拉取。请在Atlas目录(而不是Yunzai-Bot根目录)打开cmd,并执行以下语句

git clone --depth=1 https://gitee.com/Nwflower/genshin-atlas.git ./Genshin-Atlas

上述口令和指令均为原神的图鉴仓库。

如果你要获取崩坏:星穹铁道、绝区零的图鉴,请发送#星铁图鉴升级#绝区零图鉴升级,或依照本教程的开头找到图鉴仓库地址拉取对应的图鉴。

图片资源的默认获取为Gitee端,如果要从Github端获取图片资源,请发送#github原神图鉴升级#github星铁图鉴升级#github绝区零图鉴升级,只需要在初始安装时发送一次,后续便能从github端搜索更新。

代码部分的更新请使用#图鉴插件升级来更新本插件。

三、图鉴指令

获取图鉴图片后,可以根据相应的指令获取图鉴。

指令示例 指令说明 所属图鉴
#芙宁娜材料 查询角色突破材料信息 原神
#黄金剧团 查询圣遗物信息 原神
#苍古自由之誓 查询武器信息 原神
#七圣珊瑚宫心海 查询七圣卡牌(已停更 原神
#甜甜花酿鸡 查询食物信息(更新频率较慢) 原神
#无相之草 查询敌对单位信息(更新频率较慢) 原神
#鸣草 查询区域特产信息(更新频率较慢) 原神
*阮梅 查询角色信息 星穹铁道
*阮梅攻略 查询角色攻略指南 星穹铁道
*镜中故我 查询光锥信息 星穹铁道
*不老者的仙舟 查询遗器信息 星穹铁道
*外宇宙之冰 查询敌对单位信息(更新频率较慢) 星穹铁道
%格莉丝·霍华德 查询角色信息 绝区零
%加农转子 查询音擎信息 绝区零
待添加... 查询驱动盘信息 绝区零

此外,如果对某些物品的名字记忆模糊,可以根据对应索引查询:

  1. #武器索引口令唤出武器索引,逐级查询想要找的武器
  2. #原魔口令唤出原魔索引,逐级查询想要找的原魔
  3. #圣遗物口令唤出圣遗物一级索引,直接查询想要找的圣遗物
  4. 七圣召唤口令唤出七圣召唤卡牌索引,逐级查询想要找的七圣召唤卡牌

四、兼容性

本插件支持动态优先级。

因此,如果Atlas和其他插件的指令冲突,请找到对应的文件修改优先级。

如要更改插件优先级,请找到文件Atlas\resource\config.yaml下的相应属性: priority为优先级,默认为10,优先级越小,插件越不容易被抢指令,并且优先级可以为负数。 success为匹配指令拦截,默认为TRUE。更改为FALSE后,即使响应了指令、发送了图片,也会把指令继续传递给其他图鉴。

如果你对上述规则不满意,可以查阅第五点:

五、拓展:修改图鉴匹配规则(可以不修改)

如果你对当前图鉴匹配效果不满意,可以修改图鉴匹配规则以让插件更频繁或更少触发。

一般来说,默认的图鉴匹配规则是最优的,如非必要,否则不建议修改。

如果你的图鉴无法被触发,请优先检查是否被其他插件抢了指令,不要贸然修改匹配规则!!!

如果你的图鉴无法被触发,请优先检查是否被其他插件抢了指令,不要贸然修改匹配规则!!!

如果你的图鉴无法被触发,请优先检查是否被其他插件抢了指令,不要贸然修改匹配规则!!!

规则文件在resource/Forlibrary/对应图鉴库名/rule/对应分类名.yaml里查看,如不存在对应文件夹目录名(例如圣遗物artifact的对应yaml不存在,则以默认config.yaml为准)

规则文件中,mode为匹配模式。 以原神图鉴库口令#雾切之回光为例:

  1. 当模式为不完全匹配(mode:1)时,#雾切#回光#雾切之回光均视为该口令,#雾切之回光是什么武器不视为该口令。
  2. 当模式为完全匹配(mode:2)时,#雾切之回光是什么武器#神里面板换雾切之回光均视为该口令,#回光#雾切之回不视为该口令。
  3. 当模式为等同匹配(mode:0)时,仅#雾切之回光视为该口令。

规则文件中,condition为正则条件。 仍以图片雾切之回光.png为例,想要发送该图片:

  1. 当条件为直接匹配(condition:0)时,口令雾切之回光才能发送该图片。
  2. 当条件为前缀#(condition:1)时,口令#雾切之回光才能发送该图片,雾切之回光不能发送该图片。
  3. 当条件为任意关键词(condition:2)时,需要配置关键词列表(pick)。若以默认关键词图鉴为例,口令图鉴雾切之回光雾切之回光图鉴能发送该图片,雾切之回光#雾切之回光不能发送该图片,因为它们不包含关键词。
  4. 当条件为1或2(condition:3)时。满足条件1或满足条件2时都能发送该图片。除此之外,#雾切之回光图鉴也能发送该图片。但是当你的条件配置为1的时候,或者配置为2的时候(condition=1或2),这种口令不能正常触发。
  5. 当条件为1且2(condition:4)时。满足条件1的情况下还要满足条件2时才能发送该图片。如#雾切之回光图鉴#图鉴雾切之回光才能发送该图片,只满足一个不能正常触发。

规则文件中,pick为关键词列表

  1. 关键词列表只在(condition>=2)的时候才会生效。当没有配置关键词列表,则默认为“图鉴”。
  2. 以七圣召唤的规则(card.yaml)为例,pick中含有两词,分别为七圣,又因为condition==2,所以如果要发送图片凯瑟琳.png,你必须使用口令七圣凯瑟琳凯瑟琳牌才能发送该图片。
  3. 第2点中,口令#七圣凯瑟琳#凯瑟琳牌均不能发送该图片。
  4. 最终口令只与去掉关键词和前缀#的实际词语有关,而与关键词的位置、个数、种类无关。比如第2点中,口令凯七圣瑟琳七圣凯瑟琳七圣牌均能发送该图片。

特殊情况说明

  1. 你可能会发现,即使你的规则为等同匹配,#雾切也能够触发图片雾切之回光,这是因为在别名文件resource/Forlibrary/对应图鉴库名/othername/对应文件夹目录名.yaml中,雾切之回光的别名含有雾切。所以,#雾切正确匹配的是雾切雾切相当于发送雾切之回光的图片。故而,完全匹配模式中,口令#雾切之回也能触发别名雾切,从而发送雾切之回光的图片
  2. 前缀#只在(condition=1、3或4)的时候才会生效,否则将视为你文件名的一部分。

6、原神功能:原魔属性计算使用说明

在图鉴3.4或者更晚的版本中,加入了功能【原魔属性计算】可以快速查询某原魔的生命值或者攻击力。

格式形如#90级恒常机关阵列生命值#12-3魔偶剑鬼攻击力#4人无相之水生命值等等。

如何更新

更新要求 更新插件对应口令 更新原神拓展包口令 更新星铁拓展包口令
更新,但是保留本地更改 图鉴插件升级 图鉴升级 星铁图鉴升级
更新且忽略暂存区修改 图鉴插件强制升级 图鉴强制升级 星铁图鉴强制升级
回退版本后再更新 图鉴插件强行升级 图鉴强行升级 星铁图鉴强行升级
放弃所有和远端仓库不同的文件 图鉴插件强行强制升级 图鉴强行强制升级 星铁图鉴强行强制升级

致谢

ProjectName Contribution
Csxylic 提供原魔数据、原魔属性
xiaoyao-cvs-plugin 参考武器、圣遗物别名
Yunzai-Bot小飞插件 参考消息发送风控处理代码

反馈

如果你需要提出issue或者PR,请前往github的相关页面。

提出issue

发起PR

当然,你也可以使用QQ群组功能反馈。

点击加入Atlas交流群

不接受除了ISSUE、QQ反馈之外的反馈方式,感谢理解。

其他

最后给个star或者爱发电,你的支持不会获得额外内容,但会提高本项目的更新积极性

严禁用于任何商业用途和非法行为