本插件中所接入的Hammer-MaiJ机厅查卡API为本人开发的开放API,欢迎接入使用:API文档
- 将本项目的文件夹放入HoshinoBot的
hoshino/modules
目录下(可以考虑直接在该目录下用如下命令将本仓库clone至该目录下)
git clone https://github.com/ArgonarioD/hammer-maij-hoshino
- 一般情况下,利用包管理器在HoshinoBot的python环境下安装
httpx
库,如
pip install httpx==0.23.0
- 在
hoshino/config/__bot__.py
中的"启用模块"中添加"hammer-maij-hoshino"
- 用HoshinoBot自带的botmanage插件启用
maij
服务,一般情况下,只需要在机器人所在的群中使用如下指令
启用 maij
- 在你想要启用本插件的群中使用指令
maij.设置本群地区 <省市名>
后即可正常使用(注:关于本命令,请详细查看下方的“命令”章节)
注:如果您的HoshinoBot中安装了由@Yuri-YuzuChaN 开发的maimaiDX插件 ,由于本插件的指令可能与该插件有冲突,所以建议在启用本插件前将该插件路径中的
maimaiDX/maimai.py
中第787行至第815行(arcade_person
与arcade_query_person
两个函数)注释掉
在您没有更改过代码的情况下,在hammer-maij-hoshino
目录(也就是本插件的根目录)下使用如下指令即可。
git pull
若您自行更改过了本插件中的代码,则需要在git pull
后自行处理可能带来的合并冲突问题。
与其他前端(一般情况下为其他QQ群Bot)共用Hammer-MaiJ机厅查卡API
- 提交API收录的机厅中的人数供其他人查阅(+/-/=三种方式变更卡数)
- 查阅其他人提交的API收录的机厅中的人数
- 查阅机厅中卡数的变更记录(本群内存在的人显示QQ号,不在本群内存在的人显示提交时所在的QQ群名)
- 查询本城市中自当日API重置后所有更新过卡数的机厅按卡数正序排列、更新时间倒序排列的列表
注:
在下文中,COMMAND_START代表
hoshino/config/__bot__.py
文件配置中的COMMAND_START
的值,默认情况下是''
,也就是空字符串。有关本插件的公告功能,其本意是服务于:
- 当机厅遇到机身损坏、断电、断网、举办比赛等特殊情况分享;
- 失物招领、机厅群宣传等非盈利性质信息的发布。
API管理员会不定时检查公告内容,如有违规内容(如色情内容、商业性质广告)或无意义灌水会删除,严重者禁用本功能使用权限。
命令 | 说明 |
---|---|
<COMMAND_START>maij.设置本群地区 <省市名> | 为该群设置固定地区,若不设置则下列指令都无法执行;其中省市名必须为API中收录的省市,且必须为如安徽省合肥市 的标准写法,对于收录省市列表相关信息请查看API文档 |
机厅列表 | 查询本城市中自当日API重置后所有更新过卡数的机厅按卡数正序排列、更新时间倒序排列的列表 |
<机厅名称>j/jr/几/几人/几卡/有几人/有多少人/有几卡 | 查询指定机厅中的排卡数 |
<机厅名称>+/-<数字>卡 | 为指定机厅添加/移除指定卡数 |
<机厅名称>++/-- | 为指定机厅添加/移除一张卡 |
<机厅名称>=<数字>卡 | 将指定机厅设置为指定卡数 |
<机厅名称>[都]有谁 | 查询指定机厅今日的卡数变更记录 |
发[一](条/个)公告 <地名> <内容> | 发送一条公告,内容支持换行;在不续期的情况下一周后会被自动删除 |
续[一](续/ 发/下)公告 <地名> <公告ID> | 为指定公告续期一周 |
删[一](条/个)公告 <地名> <公告ID> | 删除指定的公告,只有发布者可以删除 |
- 实现了目前为止包括公告在内的API的所有功能
- 为插件中的时间显示添加了28小时制显示的选择
- 实现了“机厅列表”功能
- 更新卡数时机厅全名显示错误
发布本项目
如果觉得有用的话求点个Star啵QwQ