koishi-plugin-bilibili-notify
Version:
Koishi bilibili notify plugin
225 lines (186 loc) • 16.3 kB
Markdown
# Bilibili-Notify
基于 [koishi](../../../../koishijs/koishi) 框架的B站推送插件
---
- koishi-plugin-bilibili-notify [](https://www.npmjs.com/package/koishi-plugin-bilibili-notify)
- [重新订阅](#重新订阅)
- [功能](#功能)
- [注意事项](#注意事项)
- [安装](#安装)
- [使用方法](#使用方法)
- [更新日志](#更新日志)
- [交流群](#交流群)
- [感谢](#感谢)
- [License](#License)
## 重新订阅
由于版本 `2.0.0-alpha.7` 重构了订阅功能，从 `2.0.0-alpha.7` 以前版本升级到以后版本的需重新订阅
## 功能
订阅B站UP主动态
订阅B站UP主直播
## 注意事项
0. 动态监测，当您订阅之后，会在您设置的dynamicLoopTime(默认为2分钟)之后才会开启监测。如果您需要测试则需要等待您设置的dynamicLoopTime的时间之后再发送测试动态
1. 此插件依赖于 `database` 和 `puppeteer` 服务，同时受权限控制，需要具备 `authority:3` 及以上的权限才能使用本插件提供的指令，你可以参考下方配置登录插件中的方法得到一个超级管理员账号（具有 `authority:5` 的最高权限）
[配置登录插件](https://koishi.chat/zh-CN/manual/usage/platform.html#%E9%85%8D%E7%BD%AE%E7%99%BB%E5%BD%95%E6%8F%92%E4%BB%B6)
2. 您还可以安装 `admin` 插件，给其他用户授予权限，操作方法请参考下方的权限管理
[权限管理](https://koishi.chat/zh-CN/manual/usage/customize.html)
3. 指令使用方法请参考 `help bili`，子命令使用方法请加 `-h` ，例如 `bili login -h`
4. 登录方式为二维码，输入命令 `bili login` 之后扫码登录，您的登录凭证将存储在您的本地数据库，并由您自己填写的密钥加密，所以请保管好你的密钥
## 安装
1. 下载插件运行平台 [Koishi](https://koishi.chat/)
2. 在插件平台的 **`插件市场`** 中搜索 **`bilibili-notify`** 并安装
## 使用方法
登录B站：进行任何操作前，请先登录B站
- 使用指令 `bili login` 获取登录二维码，使用B站扫码登录
订阅UP主：订阅你想要推送的UP主
- 使用指令 `bili sub <uid> [...groupId]` 订阅需要订阅的UP主
- 参数说明：
- `uid` 为必填参数，为 `up主` 的 `uid`
- `groupId` 为可选参数，为需要推送的群号/频道号，可输入多个群号
- 选项说明：`bili sub <uid>` 有四个选项：-l -d -m -a
- `-l` 为订阅UP主直播间，包括直播开播通知，定时推送直播内容，下播通知
- `-d` 为订阅UP主动态推送，目前实现推送的动态类型有：普通图文动态，转发动态，直播预约动态
- `-m` 为多平台动态推送，格式为：群号/频道号,群号/频道号,群号/频道号.平台名;群号/频道号,群号/频道号.平台号。如果群号/频道号为 `all` 代表推送该平台下的所有群聊或/频道。在群号/频道号后加 `@` 则代表这个群聊/频道需要@全体成员。订阅TG群组时请使用 `bili sub xxx -m "xxxxxxx"` 这样的格式
- `-a` 为是否艾特全体成员，对 `-m` 参数不生效
例如：
`-m 3247293,324389,89874324.qq;EDBWIUBIU.qqguild;79324792,3247892.onebot` 代表推送QQ下3247293,324389,89874324这三个群聊，QQ频道下EDBWIUBIU这个频道，Onebot平台下79324792,3247892这两个群聊
`-m 3247293,324389@,89874324.qq` 代表推送QQ下3247293,324389,89874324这三个群聊，其中群聊324389需要艾特全体成员
所有分隔符均为英文符号
- 例如：
- `bili sub 1194210119 ` 订阅UID为1194210119的UP主动态推送和直播间
- `bili sub 1194210119 -d` 订阅UID为1194210119的UP主动态推送
- `bili sub 1194210119 -l` 订阅UID为1194210119的UP主直播间
- `bili sub 1194210119 -m 3247293,324389,89874324.qq;all.onebot;EHUIWDBUAWD.qqguild` 订阅UID为1194210119的UP主，向群号为3247293，324389，89874324的QQ群，所有onebot平台下的群聊，频道号为EHUIWDBUAWD的QQ频道平台进行推送
- `bili sub 1194210119 -a` 订阅UID为1194210119的UP主动态推送和直播间并艾特全体成员
取消订阅UP主：取消订阅不需要推送的UP主
- 使用指令 `bili unsub <uid>` 取消订阅不需要订阅的UP主
- 参数说明：`uid` 为必填参数，为 `up主` 的 `uid`
- 选项说明：`bili unsub <uid>` 有两个选项：-l 和 -d
- `-l` 为取消订阅UP主直播间
- `-d` 为取消订阅UP主动态
- 例如：
- `bili unsub 123456` 取消订阅UID为123456的UP主动态推送和直播间
- `bili unsub 123456 -d` 取消订阅UID为123456的UP主动态推送
- `bili unsub 123456 -dl` 取消订阅UID为123456的UP主动态推送和直播间
查看目前已订阅的UP主：
- 使用指令 `bili show`
插件的启动、停止和重启
- 使用指令 `sys`
- 子命令：`start`、`stop`、`restart` 分别代表插件的启动，停止和重启
## 更新日志
- ver 1.0.1 修复了一些bug，提供用户自己选择动态检测时间的选项
- ver 1.0.2 修复时间bug和字体乱码问题
- ver 1.0.3 修复了一些bug，提供用户自己选择推送卡片字体样式的选项
- ver 1.0.4 修复了重复推送的bug，提供用户选择推送卡片渲染方式的选项
- ver 1.0.5 修复了用户非法篡改数据库内容可能导致程序异常运行的bug，修复了UP主开播动态推送空白卡片的bug
- ver 1.0.6 修复了转发动态转发信息出现`undefined`的bug，修复了再次登录订阅显示错误的bug，优化了动态推送的逻辑
- ver 1.0.7 修复了在已登录情况下，再次登录会导致重复订阅和提示用户未订阅任何UP主的提示（实际上已订阅）的bug，新增了订阅对象在控制台的显示，优化了`bili show`指令的逻辑
- ver 1.0.8 修复了取消订阅的bug
- ver 1.0.9 更新请求客户端header信息。优化了动态推送卡片的页面布局，增加了字体大小。提供用户开放订阅数量限制的选项，提供用户移除推送卡片边框的选项。在控制台页面增加订阅信息提示
- ver 1.0.10 增加对`onebot`的支持，添加动态关键字屏蔽功能
- ver 1.0.11 修复了`render`渲染模式下，动态重复推送的问题，修复了没有订阅时，控制台空白提示的问题。优化了视频动态缩略图显示不全的问题，优化了部分逻辑。增强容错和增加错误提示
- ver 1.0.12 提供用户选择动态推送卡片字体增大的选项
- ver 1.0.13 修复了直播通知卡片连续发三次的bug，修复了多次调用指令 `bili login` 产生的bug
- ver 1.0.14 修复了获取二维码，二维码失效后会多次发送提示的bug，新增对`red`的支持，新增开播艾特全体成员功能，优化了部分逻辑
- ver 1.1.0-alpha.0 修复了直播订阅一段时间过后提示房间不存在的bug，修复了自动登录刷新错误的bug
- ver 1.1.0-beta.0 修复了一个bug(如果本身已经存在乱码问题的情况下，使用page模式仍然会乱码)，修复了日志bug
- ver 1.1.0-rc.0 修复了订阅用户直播一段时间后提示用户直播间不存在并自动取消订阅的bug
- ver 1.1.0 移除了直播艾特全体成员选项实验性的标志，优化了直播房间号的获取逻辑，移除了部分测试代码
- ver 1.1.1 新增依赖axios
- ver 1.1.2 修复了对red协议支持的一个bug
- ver 1.2.0-alpha.0 对自动更新登录信息的功能做了提升，修复了一些bug
- ver 1.2.0-alpha.1 对推送进行了改进：在开启直播开播艾特全体成员的情况下，发送图片后才会艾特全体成员
- ver 1.2.0-alpha.2 支持QQ群多群推送(实验性)，修复了一些bug
- ver 1.2.0-alpha.3 修复了指定QQ群订阅时的一个bug
- ver 1.2.0-alpha.4 对时间获取进行了优化，能够适应不同环境下的时间获取，修复了一些bug
- ver 1.2.0-alpha.5 修复了与PostgreSQL不兼容的问题，优化了图片推送，增强了推送容错
- ver 1.2.0-rc.0 现已支持自定义开播和下播提示语(实验性)
- ver 1.2.0-rc.1 现已支持Telegram平台(实验性)
- ver 1.2.0-rc.2 添加更多日志输出
- ver 1.2.0-rc.3 针对Telegram的bug测试版本
- ver 1.2.0-rc.4 修复了订阅指令的一个bug
- ver 1.2.0-rc.5 屏蔽动态设置新增是否发送动态被屏蔽消息的选项
- ver 1.2.0 添加屏蔽转发动态功能，添加发送动态卡片时附带文本信息和动态链接功能，支持订阅哔哩哔哩番剧出差
- ver 1.2.1 现已支持Satori平台(实验性)
- ver 1.2.2-alpha.0 bug测试
- ver 1.2.2-beta.0 修复重启koishi后，提示没有任何订阅的bug，新增对chronocat的支持(实验性)
- ver 1.2.2-beta.1 现已支持直播开播发送链接(实验性)
- ver 1.2.2-beta.2 修复了动态推送时图片下方出现空行的情况
- ver 1.2.3-alpha.0 新增主人账号功能，开启后，会将插件的错误消息向主人账号发送(实验性)。修复订阅消息推送失败刷屏的bug
- ver 1.2.3-beta.0 优化错误推送逻辑，现在只有设置主人账号后才会推送错误消息
- ver 1.2.3-beta.1 新增指令 `bili private` 方便测试主人账号功能
- ver 1.2.3-beta.2 功能测试版本，请跳过该版本
- ver 1.2.3-rc.0 现已支持向机器人加入的所有群发送推送消息(仅支持Q群，实验性)，修复预约动态无法正常推送的bug
- ver 1.2.3-rc.1 修复 `1.2.3-rc.0` 出现的重复推送bug
- ver 1.2.3-rc.2 bug测试版本，请跳过
- ver 1.2.3-rc.3 bug测试版本，请跳过
- ver 1.2.3-rc.4 bug测试版本，请跳过
- ver 1.2.3-rc.5 修复了第一次使用插件时，扫码登录后没有任何反应，并且仍提示没有登录的bug
- ver 1.2.3-rc.6 bug测试版本，请跳过
- ver 1.2.3-rc.7 尝试修复多群推送时部分群未推送的bug
- ver 1.2.3-rc.8 修复在 `1.2.3-rc.7` 版本引入的连续推送三次的bug
- ver 1.2.3-rc.9 完善了插件出错时的日志输出
- ver 1.2.3-rc.10 修复不能移除边框的bug，对图片布局进行了调整，新增下播消息发送主播头像
- ver 1.2.3-rc.11 测试版本，请跳过
- ver 1.2.3 完善主播下播消息发送头像功能，优化控制台订阅信息显示
- ver 1.2.4 优化了下播消息发送头像图片的质量和插件重启提示
- ver 1.2.5 修复了在多群订阅的情况下，其中一个群推送失败会导致其余的群全部重新推送的bug。更换图片处理依赖以解决在插件市场中被标记为不安全插件的问题
- ver 1.2.6 现在可以随机生成UA，并更新了UA
- ver 1.2.7 修复不论选择什么渲染模式都是render模式的bug，优化直播卡片推送逻辑
- ver 1.2.8 修复例如像UP主籽岷使用webp格式的头像，下播通知无法发出的bug
- ver 1.2.9-alpha.0 bug测试版本，请跳过
- ver 1.2.10 修复插件启动一段时间后一直报错的问题，更新了UA列表，新增了更多日志输出
- ver 1.2.11-alpha.0 新增自定义UA的设置。动态推送出错时，现在会直接取消订阅该UP主而不是取消订阅动态
- ver 1.2.11-alpha.1 修复报错 `app TypeError: Cannot read properties of undefined (reading 'toString')`，添加更多日志输出
- ver 1.2.12-alpha.0 新增 `sys` 类指令，包括子命令：`start`、`stop`、`restart` 分别为插件的启动、停止和重启，需要权限等级5才能使用。现在，账号出现某些问题后，不会再清除订阅信息，而是停止插件，在排除问题后需要使用指令 `sys start` 手动启动插件。修复一个动态推送的bug
- ver 1.2.12-alpha.1 删除直播推送时的多余空格
- ver 1.2.12-alpha.2 尝试修复版本 `1.2.12-alpha.0 账号出现某些问题后，不会再清除订阅信息` 仍然会清除订阅信息的bug
- ver 1.2.12-alpha.3 尝试修复订阅时使用 `all` 报错的bug
- ver 1.2.12 新增动态错误处理
- ver 1.2.13 现已支持调试模式，目前支持对动态的调试。需要调试模式可在控制台中开启
- ver 1.2.14 优化调试模式输出，直播推送卡片添加分区信息
- ver 1.2.15 新增直播推送卡片简介隐藏选项
- ver 1.2.16 当存储在数据库中的登录信息被篡改时，新增控制台提示
- ver 1.3.0-alpha.0 对直播推送逻辑进行小型重构，优化了性能。新增功能：定时推送直播卡片可选是否发送直播链接；在遇到getMasterInfo()错误时，可切换获取主播信息Api
- ver 1.3.0-alpha.1 修复bug：发送直播开播通知时，如果在开播语中加入链接，同时开启了推送直播卡片发送直播链接，则会发送两条链接
- ver 1.3.0-rc.0 修复bug：发送直播开播通知时，如果开启了开播发送链接，会在链接末尾添加一个false
- ver 1.3.0 修复bug：渲染动态时，过长的单图会导致渲染错误
- ver 1.3.1 优化过长单图的显示样式
- ver 1.3.2 增加对飞书平台的支持
- ver 1.3.3 新增直播推送人气信息展示
- ver 1.3.4 新增消息推送失败是否自动重发的选项，修复了一些潜在的bug
- ver 1.3.5 动态监测循环时间新增20分钟选项
- ver 1.3.6-alpha.0 修复bug：无限重复的报错提示
- ver 1.3.6-beta.0 取消出错自动重启插件功能
- ver 1.3.6-rc.0 修复重启或更新后提示未登录或订阅时提示请登录后再订阅的问题
- ver 1.3.6 现在基本设置中的userAgent选项为必填项，当因风控订阅失败时会提示更换UA，优化直播人气显示
- ver 1.3.7 新增设置项：插件重启后是否进行直播推送。优化直播人气显示
- ver 2.0.0-alpha.0 重构：对动态订阅进行了重构，优化了订阅流程
- ver 2.0.0-alpha.1 修复：无法成功取消订阅自己、用户没有直播间订阅直播出错。对直播订阅进行了限制，继承自以前的unlockSubLimits配置项。优化了一些配置项
- ver 2.0.0-alpha.2 新增：支持Discord平台。优化了下播通知
- ver 2.0.0-alpha.3 修复：订阅和取消订阅的bug，下播通知的bug
- ver 2.0.0-alpha.4 修复：初次订阅后不推送动态的bug 优化：下播不再发送链接
- ver 2.0.0-alpha.5 移除：选项pushUrl，选项platform 新增：选项customLive，主人账号中platform选项。支持多平台，且可同时推送不同平台，单个UP主只能推送一个平台
- ver 2.0.0-alpha.6 修复：直播推送发送失败的bug
- ver 2.0.0-alpha.7 重构：现已支持同一UP多平台推送
- ver 2.0.0-alpha.8 新增：重新订阅提示
- ver 2.0.0-alpha.9 修复：订阅反复提示未加入群组的bug，实际已加入
- ver 2.0.0-alpha.10 新增：可对每个群聊针对性设置是否艾特全体成员 优化：直播下播通知
- ver 2.0.0-alpha.11 回档：订阅时可直接接收群号/频道号 修复：直播过程推送消息不成功的bug
- ver 2.0.0-alpha.12 更改：开启艾特全体成员后，只有在开播时才艾特全体成员
- ver 2.0.0-alpha.13 修复：无法对TG群组的特殊频道号进行订阅处理；提示 `您未配置对应平台的机器人，不能在该平台进行订阅操作` 仍进行订阅操作
- ver 2.0.0-alpha.14 修复：订阅TG群组时提示输入无效
- ver 2.0.0-alpha.15 新增：手动订阅功能 修复：一些潜在的bug
- ver 2.0.0-alpha.16 优化：手动订阅功能
- ver 2.0.0-alpha.17 修复：直接订阅当前环境不会推送
- ver 2.0.0-alpha.18 修复：手动订阅无法推送直播通知；自定义直播中通知语不会发送
- ver 2.0.0-alpha.19 修复：开播通知后带false；下播通知卡片人气位置显示false
- ver 2.0.0-alpha.20 修复：直播推送失败 `Error with request send_group_msg`
- ver 2.0.0-alpha.21 修复：在某些场景下仍会出现 `2.0.0-alpha.19` 和 `2.0.0-alpha.20` 版本已修复的问题
- ver 2.0.0-alpha.22 移除：不需要的服务
- ver 2.0.0-alpha.23 优化：将艾特全体成员消息单独发送
- ver 2.0.0 修复：只订阅直播也会将该UP主的动态进行推送、推送过的动态过一段时间又会再次推送
## 交流群
801338523 使用问题或bug都可以在群里提出
## 感谢
感谢 [koishijs](https://github.com/koishijs/koishi) 官方提供的插件开发框架, 以及技术指导
## License
MIT