# Bilibili Activity Monitor
B 站用户监视器，自动监控用户的动态和直播状态，在有新动态和直播状态改变时向关注群发送提示信息。
可多群共用，每个群可以有不同的关注列表。自带数据落地存储机制，重启后可保留各群关注状态。
0.2.0 版本已支持 NoneBot2 2.0 正式版 API，依赖 OneBot V11 Adapter。
## 功能示例
### 直播提醒
![screenshot-live]
### 动态提醒
![screenshot-act-normal]
![screenshot-act-repost]
*特定用户 at 特定群友功能暂时没来得及做命令，目前需要直接改数据库，目前可以假装这个功能不存在。*
## 使用
```bash
poetry add nonebot-plugin-bam
```
```python
import nonebot
from nonebot.adapters.onebot.v11 import Adapter
nonebot.init(_env_file=".env")
driver = nonebot.get_driver()
driver.register_adapter(Adapter)
nonebot.load_builtin_plugins()
# load other plugins
# bam need this to manage background tasks
nonebot.load_plugin("nonebot_plugin_apscheduler")
nonebot.load_plugin("nonebot_plugin_bam")
nonebot.run()
```
其中 `.env` 文件除了 nonebot 的常规配置项外，还有可添加以下配置属性（下面展示的是默认值）：
```env
# 我个人喜欢用 / 来做分隔符，下面的命令列表也是以 / 为例，可以按照自己喜欢的调整
COMMAND_START=["/"]
COMMAND_SEP=["/"]
# 数据落地文件路径，建议设置一下。
# 用默认值（储存在内存中）的话一重启数据就没了
BAM_DB_FILE=":memory:"
# 重启时将所有用户的直播状态设置为未开播，而不是使用上次记录的状态。
# 正常使用不要打开此选项，是调试用的
BAM_ON_STARTUP_CLEAN_LIVE_STATUS=false
# 监控任务的间隔，这里设置的是每个用户间的间隔，而不是一轮的间隔。
# 所以如果一共关注了 N 个人（多个群关注同一个人只算一个）
# 那对于每个人来说，两次检测之间的间隔就是 N * interval
# 一般来说不要设置在 5 以下，可能会被 B 站 API 反爬而拒绝响应
BAM_MONITOR_TASK_INTERVAL=5
# 单独设置每个任务的间隔，如果没有设置，或者设置成 <= 0 的值，就会用上面那个
BAM_ACTIVITY_MONITOR_TASK_INTERVAL=0
BAM_LIVE_MONITOR_TASK_INTERVAL=0
# 使用那一个直播间状态查询 API，默认为 2，如果发现被封禁了可以临时调到 1 试试
BAM_LIVE_API=2
# 动态内容在发送到 QQ 时的最大长度，超过长度会截断，设置为 0 或负数表示不截断
BAM_ACTIVITY_CONTENT_MAX_LENGTH=0
```
## 命令列表
<details>
<summary>点击展开</summary>
### 群相关
#### 群初始化
命令：`@bot /bam/group/add [superuser_qq]`
SUPERUSER ONLY，GROUP ONLY。
在机器人加入群之后，首先使用此命令将群加入服务列表。
参数：
- superuser_qq：此群的 SUPERUSER，可以管理 Bot 在这个群的行为。可选参数，不填时则设置为使用此命令的人。
#### 删除群
命令：`@bot /bam/group/remove`
SUPERUSER ONLY，GROUP ONLY。
将当前群从服务列表中删除。
#### 群列表
命令：`/bam/group/list`
SUPERUSER ONLY，PRIVATE ONLY。
显示当前机器人服务的群列表。
### 关注相关
#### 添加关注
命令：`[@bot] /bam/follower/add [qq_group_id] <bilibili_uid>`
SUPERUSER ONLY, PRIVATE OR GROUP
为群 `qq_group_id` 添加对 B 站用户 `bilibili_uid` 的监控。
参数：
- `qq_group_id`：操作群号。可选参数，如果在群聊中使用此命令则不能加此参数，默认为当前群。
- `bilibili_uid`：B 站用户 UID，必填。
注：`[@bot]` 表示在私聊中使用时不用(无法) at 机器人，下略。
#### 删除关注
命令：`[@bot] /bam/follower/remove [qq_group_id] <bilibili_uid>`
SUPERUSER ONLY, PRIVATE OR GROUP
为群 `qq_group_id` 删除对 B 站用户 `bilibili_uid` 的监控。
参数：
- `qq_group_id`：操作群号。可选参数，如果在群聊中使用此命令则不能加此参数，默认为当前群。
- `bilibili_uid`：B 站用户 UID，必填。
#### 群关注列表
命令：`[@bot] /bam/follower/list [qq_group_id]`
SUPERUSER ONLY, PRIVATE OR GROUP
列出群 `qq_group_id` 的关注列表。
参数：
- `qq_group_id`：操作群号。可选参数，如果在群聊中使用此命令则不能加此参数，默认为当前群。
### B 站相关
#### 获取/更新用户数据
命令：`[@bot] /bam/user/fetch <bilibili_uid>`
SUPERUSER ONLY, PRIVATE OR GROUP
获取或更新 B 站用户 `bilibili_uid` 的信息。
参数：
- `bilibili_uid`：B 站用户 UID，必填。
#### 获取一个动态信息
命令：`[@bot] /bam/act <bilibili_activity_id>`
ANYONE
获取 B 站动态 `bilibili_activity_id` 的信息。
参数：
- `bilibili_activity_id`：B 站动态 ID。
</details>
## LICENSE
MIT.
[screenshot-live]: https://rikka.7sdre.am/files/af1c9c5a-5f8c-40df-b199-e97525368ec9.png
[screenshot-act-normal]: https://rikka.7sdre.am/files/5350ce1c-63f6-4f43-abcc-004e9c722063.png
[screenshot-act-repost]: https://rikka.7sdre.am/files/9c43a32b-2df7-4b93-be53-22c50a981c63.png
Raw data
{
"_id": null,
"home_page": "https://github.com/7sDream/nonebot-plugin-bam",
"name": "nonebot-plugin-bam",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "nonebot,bilibili,qqbot",
"author": "7sDream",
"author_email": "i@7sdre.am",
"download_url": "https://files.pythonhosted.org/packages/90/29/9736bb05054e904ce74ce030e69b96797ba3b1c759c8f5a9fa8c217cfa20/nonebot_plugin_bam-0.2.1.tar.gz",
"platform": null,
"description": "# Bilibili Activity Monitor\n\nB \u7ad9\u7528\u6237\u76d1\u89c6\u5668\uff0c\u81ea\u52a8\u76d1\u63a7\u7528\u6237\u7684\u52a8\u6001\u548c\u76f4\u64ad\u72b6\u6001\uff0c\u5728\u6709\u65b0\u52a8\u6001\u548c\u76f4\u64ad\u72b6\u6001\u6539\u53d8\u65f6\u5411\u5173\u6ce8\u7fa4\u53d1\u9001\u63d0\u793a\u4fe1\u606f\u3002\n\n\u53ef\u591a\u7fa4\u5171\u7528\uff0c\u6bcf\u4e2a\u7fa4\u53ef\u4ee5\u6709\u4e0d\u540c\u7684\u5173\u6ce8\u5217\u8868\u3002\u81ea\u5e26\u6570\u636e\u843d\u5730\u5b58\u50a8\u673a\u5236\uff0c\u91cd\u542f\u540e\u53ef\u4fdd\u7559\u5404\u7fa4\u5173\u6ce8\u72b6\u6001\u3002\n\n0.2.0 \u7248\u672c\u5df2\u652f\u6301 NoneBot2 2.0 \u6b63\u5f0f\u7248 API\uff0c\u4f9d\u8d56 OneBot V11 Adapter\u3002\n\n## \u529f\u80fd\u793a\u4f8b\n\n### \u76f4\u64ad\u63d0\u9192\n\n![screenshot-live]\n\n### \u52a8\u6001\u63d0\u9192\n\n![screenshot-act-normal]\n\n![screenshot-act-repost]\n\n*\u7279\u5b9a\u7528\u6237 at \u7279\u5b9a\u7fa4\u53cb\u529f\u80fd\u6682\u65f6\u6ca1\u6765\u5f97\u53ca\u505a\u547d\u4ee4\uff0c\u76ee\u524d\u9700\u8981\u76f4\u63a5\u6539\u6570\u636e\u5e93\uff0c\u76ee\u524d\u53ef\u4ee5\u5047\u88c5\u8fd9\u4e2a\u529f\u80fd\u4e0d\u5b58\u5728\u3002*\n\n## \u4f7f\u7528\n\n```bash\npoetry add nonebot-plugin-bam\n```\n\n```python\nimport nonebot\nfrom nonebot.adapters.onebot.v11 import Adapter\n\nnonebot.init(_env_file=\".env\")\n\ndriver = nonebot.get_driver()\ndriver.register_adapter(Adapter)\n\nnonebot.load_builtin_plugins()\n\n# load other plugins\n\n# bam need this to manage background tasks\nnonebot.load_plugin(\"nonebot_plugin_apscheduler\")\nnonebot.load_plugin(\"nonebot_plugin_bam\")\n\nnonebot.run()\n```\n\n\u5176\u4e2d `.env` \u6587\u4ef6\u9664\u4e86 nonebot \u7684\u5e38\u89c4\u914d\u7f6e\u9879\u5916\uff0c\u8fd8\u6709\u53ef\u6dfb\u52a0\u4ee5\u4e0b\u914d\u7f6e\u5c5e\u6027\uff08\u4e0b\u9762\u5c55\u793a\u7684\u662f\u9ed8\u8ba4\u503c\uff09\uff1a\n\n```env\n# \u6211\u4e2a\u4eba\u559c\u6b22\u7528 / \u6765\u505a\u5206\u9694\u7b26\uff0c\u4e0b\u9762\u7684\u547d\u4ee4\u5217\u8868\u4e5f\u662f\u4ee5 / \u4e3a\u4f8b\uff0c\u53ef\u4ee5\u6309\u7167\u81ea\u5df1\u559c\u6b22\u7684\u8c03\u6574\nCOMMAND_START=[\"/\"]\nCOMMAND_SEP=[\"/\"]\n\n# \u6570\u636e\u843d\u5730\u6587\u4ef6\u8def\u5f84\uff0c\u5efa\u8bae\u8bbe\u7f6e\u4e00\u4e0b\u3002\n# \u7528\u9ed8\u8ba4\u503c\uff08\u50a8\u5b58\u5728\u5185\u5b58\u4e2d\uff09\u7684\u8bdd\u4e00\u91cd\u542f\u6570\u636e\u5c31\u6ca1\u4e86\nBAM_DB_FILE=\":memory:\"\n\n# \u91cd\u542f\u65f6\u5c06\u6240\u6709\u7528\u6237\u7684\u76f4\u64ad\u72b6\u6001\u8bbe\u7f6e\u4e3a\u672a\u5f00\u64ad\uff0c\u800c\u4e0d\u662f\u4f7f\u7528\u4e0a\u6b21\u8bb0\u5f55\u7684\u72b6\u6001\u3002\n# \u6b63\u5e38\u4f7f\u7528\u4e0d\u8981\u6253\u5f00\u6b64\u9009\u9879\uff0c\u662f\u8c03\u8bd5\u7528\u7684\nBAM_ON_STARTUP_CLEAN_LIVE_STATUS=false \n\n# \u76d1\u63a7\u4efb\u52a1\u7684\u95f4\u9694\uff0c\u8fd9\u91cc\u8bbe\u7f6e\u7684\u662f\u6bcf\u4e2a\u7528\u6237\u95f4\u7684\u95f4\u9694\uff0c\u800c\u4e0d\u662f\u4e00\u8f6e\u7684\u95f4\u9694\u3002\n# \u6240\u4ee5\u5982\u679c\u4e00\u5171\u5173\u6ce8\u4e86 N \u4e2a\u4eba\uff08\u591a\u4e2a\u7fa4\u5173\u6ce8\u540c\u4e00\u4e2a\u4eba\u53ea\u7b97\u4e00\u4e2a\uff09\n# \u90a3\u5bf9\u4e8e\u6bcf\u4e2a\u4eba\u6765\u8bf4\uff0c\u4e24\u6b21\u68c0\u6d4b\u4e4b\u95f4\u7684\u95f4\u9694\u5c31\u662f N * interval\n# \u4e00\u822c\u6765\u8bf4\u4e0d\u8981\u8bbe\u7f6e\u5728 5 \u4ee5\u4e0b\uff0c\u53ef\u80fd\u4f1a\u88ab B \u7ad9 API \u53cd\u722c\u800c\u62d2\u7edd\u54cd\u5e94\nBAM_MONITOR_TASK_INTERVAL=5\n# \u5355\u72ec\u8bbe\u7f6e\u6bcf\u4e2a\u4efb\u52a1\u7684\u95f4\u9694\uff0c\u5982\u679c\u6ca1\u6709\u8bbe\u7f6e\uff0c\u6216\u8005\u8bbe\u7f6e\u6210 <= 0 \u7684\u503c\uff0c\u5c31\u4f1a\u7528\u4e0a\u9762\u90a3\u4e2a\nBAM_ACTIVITY_MONITOR_TASK_INTERVAL=0\nBAM_LIVE_MONITOR_TASK_INTERVAL=0\n\n# \u4f7f\u7528\u90a3\u4e00\u4e2a\u76f4\u64ad\u95f4\u72b6\u6001\u67e5\u8be2 API\uff0c\u9ed8\u8ba4\u4e3a 2\uff0c\u5982\u679c\u53d1\u73b0\u88ab\u5c01\u7981\u4e86\u53ef\u4ee5\u4e34\u65f6\u8c03\u5230 1 \u8bd5\u8bd5\nBAM_LIVE_API=2\n\n# \u52a8\u6001\u5185\u5bb9\u5728\u53d1\u9001\u5230 QQ \u65f6\u7684\u6700\u5927\u957f\u5ea6\uff0c\u8d85\u8fc7\u957f\u5ea6\u4f1a\u622a\u65ad\uff0c\u8bbe\u7f6e\u4e3a 0 \u6216\u8d1f\u6570\u8868\u793a\u4e0d\u622a\u65ad\nBAM_ACTIVITY_CONTENT_MAX_LENGTH=0\n```\n\n## \u547d\u4ee4\u5217\u8868\n\n<details>\n<summary>\u70b9\u51fb\u5c55\u5f00</summary>\n\n### \u7fa4\u76f8\u5173\n\n#### \u7fa4\u521d\u59cb\u5316\n\n\u547d\u4ee4\uff1a`@bot /bam/group/add [superuser_qq]`\n\nSUPERUSER ONLY\uff0cGROUP ONLY\u3002\n\n\u5728\u673a\u5668\u4eba\u52a0\u5165\u7fa4\u4e4b\u540e\uff0c\u9996\u5148\u4f7f\u7528\u6b64\u547d\u4ee4\u5c06\u7fa4\u52a0\u5165\u670d\u52a1\u5217\u8868\u3002\n\n\u53c2\u6570\uff1a\n\n- superuser_qq\uff1a\u6b64\u7fa4\u7684 SUPERUSER\uff0c\u53ef\u4ee5\u7ba1\u7406 Bot \u5728\u8fd9\u4e2a\u7fa4\u7684\u884c\u4e3a\u3002\u53ef\u9009\u53c2\u6570\uff0c\u4e0d\u586b\u65f6\u5219\u8bbe\u7f6e\u4e3a\u4f7f\u7528\u6b64\u547d\u4ee4\u7684\u4eba\u3002\n\n#### \u5220\u9664\u7fa4\n\n\u547d\u4ee4\uff1a`@bot /bam/group/remove`\n\nSUPERUSER ONLY\uff0cGROUP ONLY\u3002\n\n\u5c06\u5f53\u524d\u7fa4\u4ece\u670d\u52a1\u5217\u8868\u4e2d\u5220\u9664\u3002\n\n#### \u7fa4\u5217\u8868\n\n\u547d\u4ee4\uff1a`/bam/group/list`\n\nSUPERUSER ONLY\uff0cPRIVATE ONLY\u3002\n\n\u663e\u793a\u5f53\u524d\u673a\u5668\u4eba\u670d\u52a1\u7684\u7fa4\u5217\u8868\u3002\n\n### \u5173\u6ce8\u76f8\u5173\n\n#### \u6dfb\u52a0\u5173\u6ce8\n\n\u547d\u4ee4\uff1a`[@bot] /bam/follower/add [qq_group_id] <bilibili_uid>`\n\nSUPERUSER ONLY, PRIVATE OR GROUP\n\n\u4e3a\u7fa4 `qq_group_id` \u6dfb\u52a0\u5bf9 B \u7ad9\u7528\u6237 `bilibili_uid` \u7684\u76d1\u63a7\u3002\n\n\u53c2\u6570\uff1a\n\n- `qq_group_id`\uff1a\u64cd\u4f5c\u7fa4\u53f7\u3002\u53ef\u9009\u53c2\u6570\uff0c\u5982\u679c\u5728\u7fa4\u804a\u4e2d\u4f7f\u7528\u6b64\u547d\u4ee4\u5219\u4e0d\u80fd\u52a0\u6b64\u53c2\u6570\uff0c\u9ed8\u8ba4\u4e3a\u5f53\u524d\u7fa4\u3002\n- `bilibili_uid`\uff1aB \u7ad9\u7528\u6237 UID\uff0c\u5fc5\u586b\u3002\n\n\u6ce8\uff1a`[@bot]` \u8868\u793a\u5728\u79c1\u804a\u4e2d\u4f7f\u7528\u65f6\u4e0d\u7528(\u65e0\u6cd5) at \u673a\u5668\u4eba\uff0c\u4e0b\u7565\u3002\n\n#### \u5220\u9664\u5173\u6ce8\n\n\u547d\u4ee4\uff1a`[@bot] /bam/follower/remove [qq_group_id] <bilibili_uid>`\n\nSUPERUSER ONLY, PRIVATE OR GROUP\n\n\u4e3a\u7fa4 `qq_group_id` \u5220\u9664\u5bf9 B \u7ad9\u7528\u6237 `bilibili_uid` \u7684\u76d1\u63a7\u3002\n\n\u53c2\u6570\uff1a\n\n- `qq_group_id`\uff1a\u64cd\u4f5c\u7fa4\u53f7\u3002\u53ef\u9009\u53c2\u6570\uff0c\u5982\u679c\u5728\u7fa4\u804a\u4e2d\u4f7f\u7528\u6b64\u547d\u4ee4\u5219\u4e0d\u80fd\u52a0\u6b64\u53c2\u6570\uff0c\u9ed8\u8ba4\u4e3a\u5f53\u524d\u7fa4\u3002\n- `bilibili_uid`\uff1aB \u7ad9\u7528\u6237 UID\uff0c\u5fc5\u586b\u3002\n\n#### \u7fa4\u5173\u6ce8\u5217\u8868\n\n\u547d\u4ee4\uff1a`[@bot] /bam/follower/list [qq_group_id]`\n\nSUPERUSER ONLY, PRIVATE OR GROUP\n\n\u5217\u51fa\u7fa4 `qq_group_id` \u7684\u5173\u6ce8\u5217\u8868\u3002\n\n\u53c2\u6570\uff1a\n\n- `qq_group_id`\uff1a\u64cd\u4f5c\u7fa4\u53f7\u3002\u53ef\u9009\u53c2\u6570\uff0c\u5982\u679c\u5728\u7fa4\u804a\u4e2d\u4f7f\u7528\u6b64\u547d\u4ee4\u5219\u4e0d\u80fd\u52a0\u6b64\u53c2\u6570\uff0c\u9ed8\u8ba4\u4e3a\u5f53\u524d\u7fa4\u3002\n\n### B \u7ad9\u76f8\u5173\n\n#### \u83b7\u53d6/\u66f4\u65b0\u7528\u6237\u6570\u636e\n\n\u547d\u4ee4\uff1a`[@bot] /bam/user/fetch <bilibili_uid>`\n\nSUPERUSER ONLY, PRIVATE OR GROUP\n\n\u83b7\u53d6\u6216\u66f4\u65b0 B \u7ad9\u7528\u6237 `bilibili_uid` \u7684\u4fe1\u606f\u3002\n\n\u53c2\u6570\uff1a\n\n- `bilibili_uid`\uff1aB \u7ad9\u7528\u6237 UID\uff0c\u5fc5\u586b\u3002\n\n#### \u83b7\u53d6\u4e00\u4e2a\u52a8\u6001\u4fe1\u606f\n\n\u547d\u4ee4\uff1a`[@bot] /bam/act <bilibili_activity_id>`\n\nANYONE\n\n\u83b7\u53d6 B \u7ad9\u52a8\u6001 `bilibili_activity_id` \u7684\u4fe1\u606f\u3002\n\n\u53c2\u6570\uff1a\n\n- `bilibili_activity_id`\uff1aB \u7ad9\u52a8\u6001 ID\u3002\n\n</details>\n\n## LICENSE\n\nMIT.\n\n[screenshot-live]: https://rikka.7sdre.am/files/af1c9c5a-5f8c-40df-b199-e97525368ec9.png\n[screenshot-act-normal]: https://rikka.7sdre.am/files/5350ce1c-63f6-4f43-abcc-004e9c722063.png\n[screenshot-act-repost]: https://rikka.7sdre.am/files/9c43a32b-2df7-4b93-be53-22c50a981c63.png\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Bilibili activity monitor plugin for nonebot",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/7sDream/nonebot-plugin-bam",
"Repository": "https://github.com/7sDream/nonebot-plugin-bam"
},
"split_keywords": [
"nonebot",
"bilibili",
"qqbot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e801e9042853b795fbff0956e1e7dd1c7fd5da1be9417aaae4ed1b5ef06c5c81",
"md5": "bd5bf899c7a3fb4030db29244fef14e7",
"sha256": "31f799e1ceda75163eaf84664236aa7b21cc9961a831aa7e9c6e4a650d784e11"
},
"downloads": -1,
"filename": "nonebot_plugin_bam-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd5bf899c7a3fb4030db29244fef14e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 26562,
"upload_time": "2023-07-11T06:54:57",
"upload_time_iso_8601": "2023-07-11T06:54:57.429550Z",
"url": "https://files.pythonhosted.org/packages/e8/01/e9042853b795fbff0956e1e7dd1c7fd5da1be9417aaae4ed1b5ef06c5c81/nonebot_plugin_bam-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "90299736bb05054e904ce74ce030e69b96797ba3b1c759c8f5a9fa8c217cfa20",
"md5": "4f953c7c519b5a338b7cb8bdfe3125b6",
"sha256": "357496f51364f88b27544e0e85859883c054e994cdcaccecce531c5f609677b5"
},
"downloads": -1,
"filename": "nonebot_plugin_bam-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "4f953c7c519b5a338b7cb8bdfe3125b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 19810,
"upload_time": "2023-07-11T06:54:59",
"upload_time_iso_8601": "2023-07-11T06:54:59.557721Z",
"url": "https://files.pythonhosted.org/packages/90/29/9736bb05054e904ce74ce030e69b96797ba3b1c759c8f5a9fa8c217cfa20/nonebot_plugin_bam-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-11 06:54:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "7sDream",
"github_project": "nonebot-plugin-bam",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nonebot-plugin-bam"
}
JSON
