@cansiny0320/qq-bot

🎉 插件

通用插件

• 关键字回复
  • 吃什么/什么没吃过
  • 二维码
• 关键字撤回
• 天气预报（提醒是否有雨）
• 复读禁言
• 查看热搜（不可用状态） / 每日播报一觉醒来发生了什么

we 重邮相关插件

• 出校申请
• 一键离返校
• 每日健康打卡

掌上重邮相关插件

• 掌上重邮每日签到
• 教务在线新闻通知

其他插件

• b 站动态抓取

使用

首先应该知道的是，机器人会占用一个 QQ 号

1. 配置环境

   在根目录新建 .env 文件，内容如下：（删除注释）

   ACCOUNT = 123456 # 机器人的 QQ 号
   PASS_WORD = 'password' # 密码
   GROUP_ID = 123456 # QQ 群号

2. 使用插件

   插件列表在src/plugins目录下，使用方式为在src/index.ts导入插件后使用bot.use安装插件，例如

   import {weCqupt} from './plugins/weCqupt';
   
   bot.use(weCqupt);

   注意：某些插件目录下有配置文件，需自己按照config.example.ts中的内容，创建config.private.ts文件修改配置

3. 启动

   配置好后，执行安装命令，并启动机器人

   yarn
   
   yarn start
   
   # 或者使用 npm
   
   npm i
   
   npm run start

   查看 log

   yarn run log

4. 测试

   如机器人正常启动，则会自动在群聊发送“bot 启动成功”

TODO

• [ ] 增加查询插件帮助文档的功能，例如 help 掌上重邮
• [ ] 增加查看已启用插件的功能
• [ ] 修复微博热搜功能
• [ ] 考虑使用本地文件方式存储已通知过的教务在线新闻
• [ ] 优化天气预报功能
• [ ] 课表功能（似乎不太需要）