suyiiyii/nonebot-bison
1
0
Fork 0
mirror of https://github.com/suyiiyii/nonebot-bison.git synced 2025-06-08 04:43:00 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
nonebot-bison/docs/usage/easy-use.md
suyiiyii 54d37e254d 📝 尝试添加文档
2024-09-26 19:38:43 +08:00

7.8 KiB
Raw Blame History

prev next
/usage/install /usage/

📦 Bison 的第一个包裹

本节将教你如何开始使用 Bison 进行基础的使用， 默认你已经完成了安装并且已经成功启动了 Bison

如果你想要了解更详细的内容，请前往详细配置

🔧 骑行前检查

首先，我们需要检查一下 Bison 的配置是否正确

在最基础的使用情况下，我们只需要关注少数几个配置的内容：

  1. COMMAND_START
    这个配置是 Bison 的命令前缀，如果你的配置中没有设置，那么默认是''，也就是没有前缀
    在本节中，我们假设COMMAND_START设置中包含'/'，也就是说，我们的命令前缀是/
    例如：COMMAND_START=['', '/']

  2. BISON_TO_ME
    是否需要 @Bot 或使用 Bot 的 Nickname 来触发 Bison，默认为True
    例如：

    • BISON_TO_ME=True
      @Bot /help
    • BISON_TO_ME=False
      /help

  3. BISON_USE_PIC
    将文字渲染成图片后进行发送，多用于规避风控，默认为False

  4. BISON_USE_PIC_MERGE: 是否启用多图片时合并转发（仅限群）

    • 0: 不启用 (默认)
    • 1: 首条消息单独发送，剩余图片合并转发
    • 2: 所有消息全部合并转发

    ::: details BISON_USE_PIC_MERGE 配置项示例

    • 当BISON_USE_PIC_MERGE=1时： simple1
    • 当BISON_USE_PIC_MERGE=2时： simple1

    ::: ::: warning 选择模式1时，可能会因为待推送图片过大/过多而导致文字消息与合并转发图片消息推送间隔过大，请谨慎考虑开启。
    可以考虑选择模式2，使图文消息一同合并转发，但可能会使消息推送延迟过长 :::

::: tip 如何进行合理的配置？

  • 如果要在在 nonebot 中配置需要的Bison 配置项，请参考NoneBot 配置方式，在.env/.env.*文件中写入希望配置的 Bison 配置项
  • 请注意，在.env/.env.*中添加的配置项 不 需要声明变量类型

:::

🚲 上车！

首先，我们需要给 Bison 指定一份"订单"，让他知道我们想要订阅什么，去哪里获取包裹 ::: tip 不想在群里添加订阅？ 可以，但下述操作要求你是SUPERUSERS中的一员

  • 个人订阅
    支持私聊添加仅对自己推送的订阅，流程同下

  • 群组订阅
    支持私聊给某个群聊添加订阅，请私聊 Bison 发送群管理命令，Bison 会给你发送一个群列表，你可以选择你想要添加订阅的群聊以及执行的命令，之后的流程同下 ::: ::: warning Bison 不理我？ 在本段中COMMAND_START设置中包含了'/'，Bot 的NICKNAME="bison"

  • 如果出现 bot 不响应的问题，请先排查这个配置

  • 尝试在命令前添加设置了的命令前缀，如COMMAND_START=['!']，则尝试使用!添加订阅

  • BISON_TO_ME默认为True, 请在命令前 @Bot 或者添加 Bot 的 Nickname : @Bot 添加订阅

  • Bison 只会响应群主/群管理/SUPERUSERS 的命令，请检查你的群权限等级 :::

📝 添加订阅

选择一个群聊作为 Bison 的客户，发送添加订阅命令，Bison 会开始订阅流程 add sub

🗃️ 选择订阅的平台

Bison 会列出所支持的常用平台，你可以选择你想要订阅的平台，也可以回复全部来查看所有 Bison 支持的平台

在这里，我们选择weibo作为我们的订阅平台 choose platform

📌 给出需要订阅的目标

Bison 会要求你给出你想要订阅的目标，这个目标可以是一个 uid，也可以是特定格式的包含 uid 的链接 uid parse 这里发送了包含有 uid 的链接
:::tip 在weibo中该链接必须符合https://weibo.com/u/<uid>格式
具体请以各个平台的支持情况为准 ::: 当然，你也可以直接向 Bison 发送 uid:6279793937

🏷️ 选择需要订阅的类别

在给出需要订阅的目标后，Bison 会告诉你该 uid 所对应的用户名，你可以借此确认订阅是否正确。 接着，如果该平台支持多个类别，Bison 会要求你选择你想要订阅的类别 choose category 这里选择订阅明日方舟微博的视频 图文 文字类别，当该账号在微博发送了视频、图文、文字时，Bison 会将其派送到你的群聊中

🔖 选择需要特定订阅/屏蔽的话题 (tag)

::: tip 什么是话题 (tag)？ Tag 是社交平台中一种常见的功能，它用井号 (#) 作为前缀，标记关键词，方便用户搜索相关内容。 例如：#明日方舟# #每日打卡#（微博、哔哩哔哩） #baracamp（推特）

具体的过滤规则参见Tag 的推送规则 ::: choose tag 这里选择不特定订阅也不屏蔽话题，即全部标签

🎉 订阅成功，开始派送！

订阅流程结束后，Bison 会告诉你订阅成功，并且会在群聊中发送一条订阅成功的消息（如上图）
至此，你已经成功订阅了一个明日方舟微博账号，Bison 会在该账号发布新内容时将其派送到你的群聊中

🔍 查询订阅

你可以在任意时刻查询该群的订阅情况，只需要在群里向 Bison 发送查询订阅命令即可 query sub

🗑️ 删除订阅

你可以在任意时刻删除该群的订阅，只需要在群里向 Bison 发送删除订阅命令即可 delete sub

🌐 使用网页管理订阅

Bison 提供了一个网页管理订阅的功能，即 WebUI，你可以在网页上查看、添加、删除订阅
如果需要使用，请 私聊 Bison 发送后台管理命令，Bison 会给你发送一个网页链接，在浏览器打开即可进入网页管理订阅的界面 ::: tip 该命令无效？ 后台管理命令仅对SUPERUSERS的私聊有效 ::: ::: tip Bison 给出的链接无效？ Bison 所给的链接中的 ip 和 port 是BISON_OUTER_URL配置决定的，也就是说 Bison 本身不能获取服务器的 ip 与自身的 port，所以 Bison 给出的链接可能是无效的。你可以在BISON_OUTER_URL中设置你的服务器 ip 与 port，或者直接修改 Bison 给出的链接为正确的http://<ip>:<port>/bison/...来进入网页管理订阅的界面。

参见详细介绍 - 配置的BISON_OUTER_URL部分 ::: ::: tip 认证失败？ 🐛 在浏览器输入网址进入网页时，第一次进入可能会出现 unauthorized，请再输入网址重新进入一次，而不能简单的刷新页面 :::

🚸 魔法饼干

Bison 支持携带 Cookie 进行请求。

如果需要让 Bison 携带 Cookie 进行请求，需要先使用 添加cookie 命令添加 Cookie，然后使用 添加关联cookie 命令将 Cookie 关联到订阅上。

只有 superuser 可以管理 Cookie，只支持私聊。

打开 Bison 的私聊，发送 添加cookie 命令，Bison 会开始添加 Cookie 流程。 add cookie

然后，依次输入平台名称和 Cookie 内容。 add cookie 2

看到 Bison 的回复之后，Cookie 就添加成功啦！

接下来要关联 Cookie 到一个具体的订阅。

待添加的图片。

输入 添加关联cookie 命令，Bison 就会列出当前所有的订阅。

我们选择一个订阅，Bison 会列出所有的可以选择的 Cookie。

待添加的图片。

选择需要关联的 Cookie。

待添加的图片。

至此，Bison 便会携带我们的 Cookie 去请求订阅目标啦！