2021-07-08 20:27:31 +08:00

4.4 KiB
Raw Blame History

sidebar
auto

部署和使用

本节将教你快速部署和使用一个nonebot-hk-reporter如果你不知道要选择哪种部署方式推荐使用docker-compose

部署

本项目可以作为单独的Bot使用可以作为nonebot2的插件使用

作为Bot使用

额外提供自动同意超级用户的好友申请和同意超级用户的加群邀请的功能

docker-compose部署推荐

  1. 在一个新的目录中下载docker-compose.yml
    将其中的<your QQ>改成自己的QQ号
    wget https://raw.githubusercontent.com/felinae98/nonebot-hk-reporter/main/docker-compose.yml
    
  2. 运行配置go-cqhttp
    docker-compose run go-cqhttp
    
    通信方式选择:3: 反向 Websocket 通信
    编辑bot-data/config.yml,更改下面字段:
    account: # 账号相关
      uin: <QQ号> # QQ账号
      password: "<QQ密码>" # 密码为空时使用扫码登录
    
    message:
      post-format: array
    
    ............
    
    servers:
      - ws-reverse:
          universal: ws://nonebot:8080/cqhttp/ws # 将这个字段写为这个值
    
  3. 登录go-cqhttp 再次
    docker-compose run go-cqhttp
    
    参考go-cqhttp文档 完成登录
  4. 确定完成登录后启动bot
    docker-compose up -d
    

docker部署

本项目的docker镜像为felinae98/nonebot-hk-reporter可以直接pull后run进行使用 相关配置参数可以使用-e作为环境变量传入

直接运行(不推荐)

可以参考nonebot的运行方法 ::: danger 本项目中使用了Python 3.9的语法如果出现问题请检查Python版本 :::

  1. 首先安装poetry安装方法
  2. clone本项目在项目中poetry install安装依赖
  3. 编辑.env.prod配置各种环境变量,见Nonebot2配置
  4. 运行poetry run python bot.py启动机器人

作为插件使用

本部分假设大家会部署nonebot2

手动安装

  1. 安装pip包nonebot-hk-reporter
  2. bot.py中导入插件nonebot_hk_reporter

自动安装

使用nb-cli执行:nb plugin install nonebot_hk_reporter

配置

可参考源文件

  • 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