man是manual的意思
- 0. 概述
- 1. 插件功能与插件子开关
- 2. 机器人设置说明
- 3. 常见问题
mokabot是一个多用途QQ群机器人。
本页的内容是面向一般用户、群管理员和群主的使用手册，如有任何
- 插件工作原理和算法
- 插件使用方法
- 插件文档撰写
方面的建议，可直接提issue。
为了保证实用性，mokabot不会加入纯娱乐插件。为了保证独立性和群组之间功能的多样性，mokabot会尽量少地直接套用第三方插件，而是更多地使用自己的插件。
这一章节讲述了mokabot的实用插件的功能描述、使用方法，以及这些插件内含的子开关。
所有的指令示例和指令语法均写在了引用框中，例如下面这样：
这是一条指令语法
这是一条指令示范
这又是一条指令示范
...
一般情况下，第一行表示指令语法，从第二行开始，每一行表示一条指令示范，其中的...表示请按照该指令示范来构造更多的指令消息。
该插件为群组或私聊提供了RSS订阅功能，可定时检查RSS源并将信息传达给群组或个人。
直接使用了 Quan666/ELF_RSS 插件。详细说明请见 原始文档 。这里仅归结常用的功能。
将一个RSS路由命名为一个订阅，然后在群组或私聊中订阅它，以便在之后可以通过该订阅名来管理该订阅。该指令仅可被管理员、群主和维护者使用。
add 订阅名 RSS路由
add arcaea bilibili/user/dynamic/404145357
...
⚠请注意：
mokabot能订阅的RSS路由取决于上游RSS路由器，由于上游的限制，目前仅能订阅bilibili。
添加一个已被命名的订阅，或是启用一个已经关闭的订阅。
add 订阅名
add arcaea
...
关闭一个已经启用的订阅。
drop 订阅名
drop arcaea
...
查看群内或私聊的所有订阅情况。
showall
词云功能将会记录每天群内的聊天文字记录，并在每天预设时间（目前是23点整）将群聊热点和关键字以词云云图方式发送到群内，以及按时段分布的群聊频率（即每小时的消息条数）以条形图方式发送到群内。
以 mgsky1/FG 为基础，面向nonebot2几乎全部重构。有很多人在群里问我是不是基于词库，统计词的数量，这里统一回答下，不是的，原理可参考 该论文 。
⚠ 请注意：
开启此项功能，mokabot将会将群聊文字聊天内容以明文形式记录在服务器上，介意者请勿开启。
提供一个开启和关闭云图的开关。
开启云图
关闭云图
默认情况下将会在23点才显示本群云图和条形图，使用这个指令可以让mokabot把到目前为止的聊天记录立即生成云图并发送到群内。该指令仅可被管理员、群主和维护者使用。
立即显示云图
maimai查分、查歌、娱乐用bot，直接使用 Diving-Fish/mai-bot 。
查看今天的舞萌运势。
今日舞萌
XXXmaimaiXXX什么
maimai什么
今日maimai什么
...
随个[dx/标准][绿黄红紫白]<难度>
随个10
随个红10
随个dx红10
...
查歌<乐曲标题的一部分>
查歌PANDORA
...
[绿黄红紫白]id<歌曲编号>
红id495
...
<歌曲别名>是什么歌
我是什么歌
...
可以查询定数对应的乐曲，或是根据上下限筛选歌曲
定数查歌 <定数>
定数查歌 <定数下限> <定数上限>
详情请输入mai分数线 帮助查看
mai分数线 <难度+歌曲id> <分数线>
查询和查分器绑定了账号的b40
b40 <用户名>
查询和查分器绑定了账号的b50
b50 <用户名>
对所有使用arc查分器用户的告知：
- 由于616的众所周知的措施，原查分途径已失效，moka现采用
estertion+webapi双重查分方案，两个方案之间完全独立运行。- 如果你需要使用
estertion查分方案，请使用arc查询指令，然后请耐心等待3~10分钟（实际时间取决于est那边排队时间，也有可能根本排不上）。- 如果你需要使用webapi查分方案，请使用
arc最近指令，理论上是几秒之内就能返回。webapi查分基于其原理有两个必要条件：
- 你的账号在查分器所用账号的好友列表中（即查分器已经加你为好友）。
- 查分器能在返回的所有好友的成绩中识别出你的成绩（即查分器认识你）。
- 基于上述必要条件，用户必须先使用
arc绑定绑定好友码，然后使用arc绑定用户名来绑定用户名，然后请等待开发者通过你绑定的好友码添加你到查分器的好友列表中。- 2021年7月前已绑定过arc好友码的用户，我已经提前人工逐个添加你们为好友，故无需进行上述等待，但你们一样需要绑定用户名才能使用备用查分器。
⚠ 常见误区：
- 绑定用户名后认为
arc查询会变快（并不会变快，而且两个方案是独立的）。- 绑了用户名却没绑好友码（没好友码我没法加你为好友）
- 认为查分器没有响应，频繁使用
arc查询（不是没响应，是在排队）。- 绑定了错误的用户名（可能是输入错误），导致查分器没法筛选出你的成绩。
从查分器查询某一id的信息，信息格式与查分器一致。
⚠ 请注意：
旧版本的arc最近 <好友码>、arc查询 <歌曲名>、arc强制查询在当前环境下均不可用，请仅使用下述的arc查询和arc最近指令。
arc最近 # 查询你的最近成绩，请先绑定用户名和好友码
arc查询 # 查询你的arc信息，在目前环境下不推荐，需要排队等待
arc查询 <好友码> # 查询指定好友码的arc信息，在目前环境下不推荐，需要排队等待
⚠ 请注意：
为了让你可以舒适友好地使用Arcaea成绩查询功能，请不要只绑定好友码或只绑定用户名，至于为什么请阅读该小节头部的《对所有使用arc查分器用户的告知》。
绑定完用户名后请等待我人工将你的账号添加至查分器列表中（快的话1分钟之内，慢的话1小时之内）。
arc绑定 114514191
arc绑定用户名 FuLowiriCk
...
不要 只绑定好友码 或 只绑定用户名
不要 只绑定好友码 或 只绑定用户名
不要 只绑定好友码 或 只绑定用户名
每100个人中就有2个人只绑用户名不绑好友码，直接给我整不会了
未设置这一项之前，你使用arc最近时，mokabot返回的成绩图是一个随机样式。设置之后，将会变更为一个确定的样式。
目前有三个样式：moe、guin、bandori
arc查分样式 bandori
...
以多种方式发送Arcaea的定数表，以及PM难度表和TC难度表。
发送 @Arcaea_I_G 制作的推特定数表，目前推特定数表已经可以自动更新。
const8
const9
const10
发送 Arcaea中文维基定数表 。不加参数时默认按歌曲名升序，加参数则认为按照指定难度降序。
定数表
定数表 ftr
...
发送 Arcaea中文维基PM难度表 。
pm表
发送 Arcaea中文维基TC难度表 ，TC指的是推分。
tc表
众所周知，已知Arcaea的定数、分数、评价中的其中任意两个，可以推算出第三个的值。命令请用arc计算作为开头，然后按照示范输入你的已知值。
⚠ 请注意：
所有数字使用浮点或整数均可，但分数必须以万作为单位
arc计算 定数10 分数979
arc计算 分数999.95 定数10
arc计算 评价12.2 分数1000
同上，已知Arcaea的ptt、b30、r10中的其中任意两个，可以推算出第三个的值。命令请用arc计算作为开头，然后按照示范输入你的已知值。
⚠ 请注意：
所有数字使用浮点或整数均可
arc计算 ptt11.5 b11.45
arc计算 ptt11.31 r11.8
arc计算 b10.11 r11.5
从 Bandori车站 获取最新车牌。
⚠ 请注意：
ycm、车来、有车吗都能触发该命令。为了避免和Tsugu冲突，这个命令只能由@机器人或私聊触发，请尽量使用Tsugu查询，仅在Tsugu无法正常使用的时候使用moka查询车牌
@mokabot ycm
@mokabot 车来
⚠ 请注意：
由于上游不再更新，该功能已经弃用。如果我在以后开发出了自动解析邦邦谱面文件功能，可能会考虑重做该功能。
请查看命令示范，并且搭配谱面列表使用。
难度标记：ez(easy) no(normal) hd(hard) ex(expert) sp(special)，末尾可以加M(mirror)
查询谱面 243ex （查询火鸟(full)ex谱面）
查询谱面 128sp （查询六兆年的special谱面）
查询谱面 001ez （查询ybd的easy谱面）
查询谱面 037exM（查询贼船ex镜像谱面）
查询谱面 烤全鸡 （已映射的谱面可以查询别名）
...
将谱面别名映射到标准谱面id，标准谱面id和谱面查询所用的格式相同，你需要搭配谱面列表使用。
谱面映射 <谱面别名> <标准谱面id>
谱面映射 六兆年sp 128sp
谱面映射 烤全鸡 243ex
...
<开启/关闭><国服/日服>公告
关闭国服公告
开启日服公告
...
将目前所有已经收录的谱面生成列表，可以按照ex难度降序或者歌曲标号升序。
谱面列表 # 默认，按照歌曲标号升序
谱面列表ex # 按照ex难度降序
从 bestdori 生成一个包含活动id、活动类型、活动时间与活动名称的列表。
活动列表 <服务器代号(JP,CN,EN,TW,KR)>
活动列表 JP
活动列表 CN
...
查看阿怪制作的hsr表（日服）。
⚠ 请注意：
更新时间：2021-08-12
hsr表
从 bestdori 查询最新榜线，同时计算预测档线可以查询bestodri上已存在的除了T10以外的档线。建议搭配活动列表使用。当活动id为0的时候，认为你查询的是最新一期的档线和预测。
⚠ 请注意：
moka使用的是自己的而不是bestdori的预测数学模型，档线的预测结果仅供参考，moka对此不负任何损失带来的责任。
分数线 104JP1000 # 日服104期T1000档线和预测
分数线 30CN2000 # 国服30期T2000档线和预测
分数线 0JP1000 # 日服最新一期T1000档线和预测
计算催化剂的最佳采集地点。通过给定若干个催化剂，moka可以按算法计算出所有副本中采集这些催化剂的最佳地点，并计算每个副本的得分。以此帮助玩家快速确定刷狗粮的地点。
⚠ 请注意：
建议输入2~5个催化剂以获得最佳体验。
查询催化剂 <你所需的催化剂列表>
查询催化剂 荣耀的戒指 古代生物的核心 弯曲的犬齿
...
返回一个游戏中所有的催化剂列表来方便你复制它的名字（以避免你打错字）。
催化剂列表
该模块尝试解析某些网站的url链接，例如当用户发送一段关于哔哩哔哩视频的链接时，mokabot将会解析该链接的视频并生成相应的元数据。
目前已经可以对以下网站的url提供解析：
- 哔哩哔哩
- 哔哩哔哩小程序
- YouTube
- 知乎
- 百度贴吧
- Github
- 知乎小程序 （正在制作中）
- 百度贴吧小程序 （正在制作中）
- Twitter （正在制作中）
一个使用了 VNDB（The Visual Novel Database）API 的查询工具，可以检索并展示Galgame、角色、声优等元数据。
你可以对以下内容进行检索：Galgame名称、角色名称、声优名称，分别对应gal、char、cv。bot将会返回这些内容对应的id，你可以通过id来显示详细信息。
vndb <gal/char/cv> search XXXXXXX
vndb gal search Riddle Joker
vndb char search ハチロク
vndb cv search 種﨑 敦美
...
⚠ 请注意：
vndbAPI的搜索功能并不是很聪明，请尽量避免模糊搜索，并且在搜索人名时尽量使用日文原名，并用空格将姓和名隔开。在搜索作品时请注意，当作品名带符号时，不要忽略夹杂在文字中间的符号，或者可以考虑输入在第一个符号之前出现的文字。
将上一条的search换成id即可。作用是展示对应id的详细信息。
vndb <gal/char/cv> id XXXXXXX
vndb char id 39202
vndb cv id 196
...
作品之间的关系是由英语词汇翻译而来，若有更好的翻译建议可以群内找我或者发issue。目前的翻译对应如下
| 原文 | 翻译 | 备注 |
|---|---|---|
| Sequel | 续作 | |
| Prequel | 前作 | |
| Same setting | 同一设定 | |
| Alternative version | 替代版本 | 有无更好的中文叫法？ |
| Shares characters | 角色客串 | 共享角色一定是客串吗？ |
| Side story | 支线故事 | 有无更好的中文叫法？ |
| Parent story | 主线剧情 | 有无更好的中文叫法？ |
| Same series | 同一系列 | |
| Fandisc | FanDisc | |
| Original game | 原作 | 在vndb里这个和FD是互逆关系，但是我不知道这种关系是不是叫原作 |
示例：
- まいてつ 和 まいてつ Last Run!! 是
Alternative version关系。 - ものべの 和 ものべの -happy end 也是
Alternative version关系。 - まいてつ 和 ものべの -happy end 是
Shares characters关系。 - ものべの -happy end 是 あやかし郷愁譚 互为
Parent story和Side story的关系。
直接使用 HibiKier/nonebot_plugin_statistical 。以下指令除功能调用统计、日功能调用统计、周功能调用统计、月功能调用统计、我的功能调用统计、我的日功能调用统计、我的周功能调用统计和我的月功能调用统计外，其他所有功能仅供开发者使用，即使是群管理员和群主也无法使用！
| 命令 | 参数 | 说明 | 示例 |
|---|---|---|---|
| 功能调用统计/我的功能调用统计 | 无 | 以柱状图的方式展示从开始统计开始到现在的全部数据 | 无 |
| 日功能调用统计/我的日功能调用统计 | 无 | 以柱状图的方式展示今日功能调用数据 | 无 |
| 周功能调用统计/我的周功能调用统计 | [cmd] | 当未有参数时，以柱状图展示一周内的功能调用 当有参数时，以折线图的方式展示该功能一周内的调用情况 |
周功能调用统计 周功能调用统计色图 |
| 月功能调用统计/我的月功能调用统计 | [cmd] | 同上 | 同上 |
| 重载统计数据 | 无 | 用于手动修改 plugin2cmd.json 文件后重载 | 无 |
| 添加统计cmd | [cmd] [new_cmd] | 为模块新增cmd(别名)，通过参数[cmd]查找到所在模块后添加[new_cmd] | 添加统计cmd 色图 涩图 |
| 删除统计cmd | [cmd] | 删除模块的cmd(别名) | 删除统计cmd 色图 |
| 显示统计cmd | [cmd] | 展示该模块的所有cmd(别名)，通过参数[cmd]查找到该模块 | 显示统计 色图 |
| 提升统计cmd | [cmd] | 提升参数[cmd]所在模块的cmd列表中位置至cmd[0]，cmd[0]位置用于在图表上显示 | 提升统计cmd 色图 |
| 添加统计展示白名单 | [cmd] | 将某模块不在图表上展示，通过指定cmd来查询的话会以未查询到数据回绝，通过参数[cmd]来添加对应模块 | 添加统计展示白名单 色图 |
| 删除统计展示白名单 | [cmd] | 将某模块从白名单中删除，通过参数[cmd]来添加对应模块 | 删除统计展示白名单 色图 |
| 显示统计展示白名单 | 无 | 显示当前的统计展示白名单 | 显示统计展示白名单 |
修改自 chinosk114514/ChieriBot-miHoYo_Query 。用于查询米游社通行证ID所绑定的原神、崩坏三数据。
⚠ 请注意：
请不要将原神uid或崩坏三uid作为通行证ID进行绑定。请确定你所绑定的是米游社通行证ID。
米游社通行证绑定 <你的通行证ID>
米游社绑定 <你的通行证ID>
米游社绑定 123456789
...
和arc查询、arc绑定同理，当用户已经绑定过米游社通行证时，可以不加参数进行查询。
原神查询
深渊查询
崩坏查询
原神查询 123456789
深渊查询 123456789
崩坏查询 123456789
...
用于在你不知所措的时候随机选择
moka选择 吃饭 打游戏 睡觉
...
直接采用 nonepkg/nonebot-plugin-manager 进行管理。
以下为该插件的一个简单示例：
| 命令 | 参数 | 说明 | 示例 |
|---|---|---|---|
npm ls |
无 | 展示当前会话中的所有插件的开关情况 | npm ls |
npm block |
插件名 | 在当前会话中关闭某一插件 | npm block mb2pkg_epic7 |
npm unblock |
插件名 | 在当前会话中开启某一插件 | npm unblock mb2pkg_url_parse |
直接采用 MeetWq/nonebot-plugin-alias 。
通过设置别名，你可以将一个复杂的指令记成一个好记的指令，或是防止mokabot的指令和其他机器人的指令发生冲突。
- 例如，你可以将将
fsx设置成分数线的别名，这样当你输入fsx 0JP1000时，mokabot会认为你输入了分数线 0JP1000。 - 反过来，你也可以将
help设置成hasjkfhjklejo（任意乱字符串）的别名，这样当你输入help时，mokabot会认为你输入了hasjkfhjklejo，因此mokabot将不会响应该help指令，以防止和其他机器人的指令产生冲突。
| 命令 | 参数 | 说明 | 示例 |
|---|---|---|---|
alias |
[别名]=[指令名称] |
将别名链接到一个指令名称 | alias fsx=分数线 |
alias |
别名 |
查看别名指向的是哪个指令 | alias fsx |
alias |
-p |
查看当前会话中的所有别名 | alias -p |
unalias |
别名 |
取消该别名到其他指令名称的链接 | unalias fsx |
unalias |
-a |
取消该会话中所有别名到其他指令名称的链接 | unalias -a |
主动消息是指当mokabot没有接受到任何明确调用指令时，自行发送的消息。由于此类消息可能会扰民，因此特地列出一个小节来说明如何设置这些主动消息的开关，以及这些开关的默认设置。
| 功能 | 补充说明 | 隶属插件 | 开关方式 | 默认状态 |
|---|---|---|---|---|
| 群聊词云 | 每天23:00发送群聊词云，展示该群聊天热点话题和每小时的消息条数 | 群聊词云 | 开启/关闭云图 |
❌ |
| 邦邦公告 | 每15分钟检索一次邦邦游戏内公告 | Bandori | 开启/关闭国/日服公告 |
日服：❌ 国服：❌ |
| url解析 | 自动解析群聊中的某些链接（bilibili、github等） | URL解析 | npm (un)block mb2pkg_url_parse |
✔ |
目前，你可以自由地将moka添加到任何群组，也能自由地添加moka为好友，moka会自动同意所有的加群邀请和好友申请。
向moka直接发送群二维码图片是错误的邀请方法，正确将moka拉入群的方法是使用群资料页面的群聊成员->邀请按钮（需要群主事先打开允许群成员邀请好友入群权限）。
- 如果一个插件的触发是基于指令的（也是绝大多数情况下的情况），那么群主、管理员和维护者可以通过如下指令来查看其状态并启用或禁用它：
npm ls # 展示当前会话中的所有插件的开关情况
npm block XXXX # 关闭名为XXXX的插件
npm unblock XXXX # 启用名为XXXX的插件
⚠ 请注意：
- 使用
npm来控制插件的开关状态时，会导致启用/禁用整个插件的功能，而不是部分指令。- 默认情况下，所有插件在
npm中都是启用状态。
- 如果一个插件是主动消息（例如群聊词云、邦邦公告和url解析），请参考 2.3 主动消息开关表 来控制它。