mirror of
https://github.com/suyiiyii/nonebot-bison.git
synced 2026-05-09 18:27:56 +08:00
update docs
This commit is contained in:
+36
-1
@@ -1,5 +1,6 @@
|
||||
---
|
||||
sidebar: auto
|
||||
sidebarDepth: 4
|
||||
---
|
||||
# 部署和使用
|
||||
本节将教你快速部署和使用一个nonebot-hk-reporter,如果你不知道要选择哪种部署方式,推荐使用[docker-compose](#docker-compose部署-推荐)
|
||||
@@ -18,7 +19,7 @@ sidebar: auto
|
||||
```bash
|
||||
docker-compose run cq-http
|
||||
```
|
||||
通信方式选择:3: 反向 Websocket 通信
|
||||
通信方式选择:`3: 反向 Websocket 通信`
|
||||
编辑`bot-data/config.yml`,更改下面字段:
|
||||
```
|
||||
account: # 账号相关
|
||||
@@ -44,7 +45,41 @@ sidebar: auto
|
||||
```
|
||||
#### docker部署
|
||||
#### 直接运行(不推荐)
|
||||
::: danger
|
||||
本项目中使用了Python 3.9的语法,如果出现问题,请检查Python版本
|
||||
:::
|
||||
### 作为插件使用
|
||||
本部分假设大家会部署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
|
||||
|
||||
Reference in New Issue
Block a user