nonebot-bison/README.md
2021-02-09 10:44:02 +08:00

71 lines
2.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# hk-reporter 通用订阅推送插件
## 简介
一款自动爬取各种站点社交平台更新动态并将信息推送到QQ的机器人。基于 [`NoneBot2`](https://github.com/nonebot/nonebot2 ) 开发(诞生于明日方舟的蹲饼活动)
支持的平台:
* 微博
* 图片
* 文字
* 不支持视频
* 不支持转发的内容
* bilibili
* 图片
* 专栏
* 文字
* 视频链接
* 不支持转发的内容
* rss
* 从description中提取图片
* 文字
## 使用方法
### 使用以及部署
本项目可作为单独插件使用仅包含订阅相关功能绝对simple和stupid也可直接克隆项目进行使用包含自动同意superuser自动接受入群邀请等功能
作为插件使用请安装`nonebot-hk-reporter`包,并在`bot.py`中加载`nonebot_hk_reporter`插件;或直接克隆本项目进行使用
配置与安装请参考[nonebot2文档](https://v2.nonebot.dev/)
### 配置变量
* `HK_REPORTER_CONFIG_PATH` (str) 配置文件保存目录,如果不设置,则为当前目录下的`data`文件夹
* `HK_REPORTER_USE_PIC` (bool) 以图片形式发送文字(推荐在帐号被风控时使用)
* `HK_REPORTER_USE_LOCAL` (bool) 使用本地chromium文字转图片时需要否则第一次启动会下载chromium
### 命令
所有命令都需要@bot触发
* 添加订阅(仅管理员和群主):`添加订阅 平台代码 uid`
* 查询订阅:`查询订阅`
* 删除订阅(仅管理员和群主):`删除订阅 平台代码 uid`
平台代码包含weibobilibilirss
<details>
<summary>各平台uid</summary>
下面均以pc站点为例
* weibo
* 对于一般用户主页`https://weibo.com/u/6441489862?xxxxxxxxxxxxxxx``/u/`后面的数字即为uid
* 对于有个性域名的用户如:`https://weibo.com/arknights`,需要点击左侧信息标签下“更多”,链接为`https://weibo.com/6279793937/about`其中中间数字即为uid
* bilibili
* 主页链接一般为`https://space.bilibili.com/161775300?xxxxxxxxxx`数字即为uid
* rss
* rss链接即为uid
</details>
### 文字转图片
因为可能要发送长文本所以bot很可能被风控如有需要请开启以图片形式发送文字本项目使用的图片转文字方法是chromium经典杀鸡用牛刀
如果确定要开启推荐自行安装chromium设置使用本地chromium并且保证服务器有比较大的内存。
## 功能
* 定时爬取制定网站
* 通过图片发送文本,防止风控
* 使用队列限制发送频率
## 鸣谢
* [`go-cqhttp`](https://github.com/Mrs4s/go-cqhttp):简单又完善的 cqhttp 实现
* [`NoneBot2`](https://github.com/nonebot/nonebot2):超好用的开发框架
* [`HarukaBot`](https://github.com/SK-415/HarukaBot/): 借鉴了大体的实现思路
## License
MIT