mirror of
https://github.com/suyiiyii/nonebot-bison.git
synced 2025-07-15 04:33:01 +08:00
update docs
This commit is contained in:
felinae98
parent
de2a8bfd61
commit
d6b171acf7
49
README.md
49
README.md
@ -12,6 +12,8 @@
|
|||||||
## 简介
|
## 简介
|
||||||
一款自动爬取各种站点，社交平台更新动态，并将信息推送到QQ的机器人。基于 [`NoneBot2`](https://github.com/nonebot/nonebot2 ) 开发（诞生于明日方舟的蹲饼活动）
|
一款自动爬取各种站点，社交平台更新动态，并将信息推送到QQ的机器人。基于 [`NoneBot2`](https://github.com/nonebot/nonebot2 ) 开发（诞生于明日方舟的蹲饼活动）
|
||||||
|
|
||||||
|
安装配置见[文档](https://nonebot-hk-reporter.vercel.app)
|
||||||
|
|
||||||
支持的平台：
|
支持的平台：
|
||||||
* 微博
|
* 微博
|
||||||
* 图片
|
* 图片
|
||||||
@ -28,54 +30,7 @@
|
|||||||
* 从description中提取图片
|
* 从description中提取图片
|
||||||
* 文字
|
* 文字
|
||||||
|
|
||||||
## 使用方法
|
|
||||||
|
|
||||||
### 使用以及部署
|
|
||||||
**!!本项目需要Python3.9及以上**
|
|
||||||
本项目可作为单独插件使用，仅包含订阅相关功能（绝对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~~
|
|
||||||
* `HK_REPORTER_BROWSER` (str) 明日方舟游戏公告和以以图片形式发送文字需要浏览器支持，如果不设置会在使用到
|
|
||||||
功能的时候自动下载Chromium（不推荐）
|
|
||||||
* 使用本地安装的Chromiun: 设置为`local:<chromium path>`
|
|
||||||
* 使用browserless提供的服务浏览器管理服务（推荐）:设置为`ws://********`
|
|
||||||
|
|
||||||
同时，建议配置`SUPERUSERS`环境变量便于机器人管理
|
|
||||||
|
|
||||||
### 命令
|
|
||||||
#### 在本群中进行配置
|
|
||||||
所有命令都需要@bot触发
|
|
||||||
* 添加订阅（仅管理员和群主和SUPERUSER）：`添加订阅`
|
|
||||||
* 查询订阅：`查询订阅`
|
|
||||||
* 删除订阅（仅管理员和群主和SUPERUSER）：`删除订阅`
|
|
||||||
#### 私聊机器人进行配置（需要SUPERUER权限）
|
|
||||||
* 添加订阅：`管理-添加订阅`
|
|
||||||
* 查询订阅：`管理-查询订阅`
|
|
||||||
* 删除订阅：`管理-删除订阅`
|
|
||||||
|
|
||||||
平台代码包含：Weibo，Bilibili，RSS
|
|
||||||
<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，并且保证服务器有比较大的内存。
|
|
||||||
## 功能
|
## 功能
|
||||||
* 定时爬取指定网站
|
* 定时爬取指定网站
|
||||||
* 通过图片发送文本，防止风控
|
* 通过图片发送文本，防止风控
|
||||||
|
|||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
sidebar: auto
|
sidebar: auto
|
||||||
|
sidebarDepth: 4
|
||||||
---
|
---
|
||||||
# 部署和使用
|
# 部署和使用
|
||||||
本节将教你快速部署和使用一个nonebot-hk-reporter，如果你不知道要选择哪种部署方式，推荐使用[docker-compose](#docker-compose部署-推荐)
|
本节将教你快速部署和使用一个nonebot-hk-reporter，如果你不知道要选择哪种部署方式，推荐使用[docker-compose](#docker-compose部署-推荐)
|
||||||
@ -18,7 +19,7 @@ sidebar: auto
|
|||||||
```bash
|
```bash
|
||||||
docker-compose run cq-http
|
docker-compose run cq-http
|
||||||
```
|
```
|
||||||
通信方式选择：3: 反向 Websocket 通信
|
通信方式选择：`3: 反向 Websocket 通信`
|
||||||
编辑`bot-data/config.yml`，更改下面字段：
|
编辑`bot-data/config.yml`，更改下面字段：
|
||||||
```
|
```
|
||||||
account: # 账号相关
|
account: # 账号相关
|
||||||
@ -44,7 +45,41 @@ sidebar: auto
|
|||||||
```
|
```
|
||||||
#### docker部署
|
#### docker部署
|
||||||
#### 直接运行（不推荐）
|
#### 直接运行（不推荐）
|
||||||
|
::: danger
|
||||||
|
本项目中使用了Python 3.9的语法，如果出现问题，请检查Python版本
|
||||||
|
:::
|
||||||
### 作为插件使用
|
### 作为插件使用
|
||||||
本部分假设大家会部署nonebot2
|
本部分假设大家会部署nonebot2
|
||||||
## 配置
|
## 配置
|
||||||
|
* `HK_REPORTER_CONFIG_PATH`: 插件存放配置文件的位置，如果不设定默认为项目目录下的`data`目录
|
||||||
|
* `HK_REPORTER_USE_PIC`: 将文字渲染成图片后进行发送，多用于规避风控
|
||||||
|
* `HK_REPORTER_BROWSER`: 在某些情况下需要使用到chrome进行渲染
|
||||||
|
* 使用browserless提供的Chrome管理服务，设置为`ws://xxxxxxxx`，值为Chrome Endpoint（推荐）
|
||||||
|
* 使用本地安装的Chrome，设置为`local:<chrome path>`，例如`local:/usr/bin/google-chrome-stable`
|
||||||
|
* 如果不进行配置，那么会在使用到Chrome的时候自动进行安装（不推荐）
|
||||||
|
### 需要使用Chrome的情况
|
||||||
|
* 设置了`HK_REPORTER_USE_PIC`，需要将文字渲染成图片
|
||||||
|
* 渲染明日方舟游戏内公告
|
||||||
## 使用
|
## 使用
|
||||||
|
::: warning
|
||||||
|
本节假设`COMMAND_START`设置中包含`''`，如果出现bot不响应的问题，请先
|
||||||
|
排查这个设置
|
||||||
|
:::
|
||||||
|
### 命令
|
||||||
|
#### 在本群中进行配置
|
||||||
|
所有命令都需要@bot触发
|
||||||
|
* 添加订阅（仅管理员和群主和SUPERUSER）：`添加订阅`
|
||||||
|
* 查询订阅：`查询订阅`
|
||||||
|
* 删除订阅（仅管理员和群主和SUPERUSER）：`删除订阅`
|
||||||
|
#### 私聊机器人进行配置（需要SUPERUER权限）
|
||||||
|
* 添加订阅：`管理-添加订阅`
|
||||||
|
* 查询订阅：`管理-查询订阅`
|
||||||
|
* 删除订阅：`管理-删除订阅`
|
||||||
|
### 所支持平台的uid
|
||||||
|
#### 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
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user