这是一个提供符合中国宝宝体质的定时提醒功能的插件
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装nb plugin install nonebot-plugin-remind
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令pip
pip install nonebot-plugin-remind
打开 nonebot2 项目根目录下的 pyproject.toml
文件, 在 [tool.nonebot]
部分追加写入
plugins = ["nonebot_plugin_remind"]
在 nonebot2 项目的.env
文件中添加如下可选配置
配置项 | 必填 | 默认值 | 说明 |
---|---|---|---|
private_list_all |
否 | Ture |
私聊中"/提醒列表"命令是否列出私聊群聊全部提醒 |
remind_keyword_error |
否 | Ture |
触发“提醒”关键词时是否发送错误提示 |
GLM_4_MODEL |
否 | "" |
仅用于解析单次提醒的GLM-4系列大模型的名称 |
GLM_4_MODEL_CRON |
否 | "" |
仅用于解析循环提醒的GLM-4系列大模型的名称 |
GLM_API_KEY |
否 | "" |
GLM-4系列大模型的API_KEY |
触发格式:
[@][时间]'提醒'[被提醒人][消息]
各部分解释:
-
[@](以下条件任意满足一条即可)
- 在消息开头@机器人
- 回复机器人的任意一条消息
- 如果机器人设置了
NICKNAME
环境变量,则只需在消息开头称呼其昵称
-
[时间](以下时间格式均符合要求):必须使用北京时间24小时制
2025-1-1-8:00
: 精确设定2025年1月1日上午8:009.10.18:00
或者9.10.18.00
: 设定距离当前时间最近的未来的9月10日18:0021:12
或者21.12
: 设定距离当前时间最近的未来的21点12分- 当正确配置了
GLM_4_MODEL
和GLM_API_KEY
这两个环境变量之后,你将获得更自由更符合人类语言的丰富体验,不再局限于上述有限的几种时间格式,包括但不限于以下几种情况将被支持:明天晚上八点1刻
20分钟后
下周三的同一时间
今年的教师节早上八点
10月1日提前10天的正午12点
- ……
- 特别提醒: 推荐使用免费的"glm-4-flash"模型,即可满足大部分简单需求。越复杂的时间描述(如
一坤时后
)对大语言模型的理解能力需求越高,需合理选择大模型。
除此之外,时间部分还支持循环提醒的设置(默认采用正则表达式匹配)
每年3月12日7:00
每月22日22:00
每周一三五18:00
每天15:00
每小时30分
可匹配的正则表达式如下:
"每个?小?时的?(\d{1,2})分?" "每天的?(\d{1,2})[::.点](\d{1,2})分?" "每个?月的?(\d{1,2})[号日.]的?(\d{1,2})[::.点](\d{1,2})分?" "每个?年的?(\d{1,2})[月.](\d{1,2})[号日.]的?(\d{1,2})[::.点](\d{1,2})分?" "每个?(?:周|星期|礼拜)的?([一二三四五六七日天]+)的?(\d{1,2})[::.点](\d{1,2})分?"
- 特别提醒: 与单次提醒不同,免费的"glm-4-flash"模型在解析循环提醒获取参数时表现不佳,建议选择更智能的模型,比如"glm-4-plus",因此提供了不同的环境变量设置 (
GLM_4_MODEL_CRON
) 。
-
'提醒': 要匹配的关键字,必须完全一致
-
[被提醒人](以下格式均符合要求)
我
:提醒设定提醒的人自己[@]
:可以@多个用户,包括自己,也可以@全体成员我和[@]
:必须我在前面,其他@用户在后all
或者所有人
: 等同于@全体成员
,提供一个非打扰式的提醒设定
-
[消息]
- 任意消息(支持图片、QQ黄脸表情等富文本消息)均可,前提是必须在同一条消息中发送出
示例:
@机器人 16:00提醒我去开会
机器人昵称,1.1.11.40提醒所有人去聚餐
机器人昵称 2025-1-29-8:00提醒我和@用户1 用户2 新年新气象!
- 错误示例:
@机器人 明天16:00提醒我去开会
,此时默认情况机器人会报错,配置环境变量remind_keyword_error=false
可关闭匹配错误时的提醒。
以下触发均需要指令前缀,如未设置默认为/
。
-
提供1个参数为
被提醒人
,以交互的方式设置提醒: -
提供3个参数,以英文逗号
,
间隔,依次为:被提醒人
,时间
和提醒消息
:
以上两种命令的触发方式均可省略
被提醒人
参数,省略时默认被提醒人为“我”。
列表顺序默认按提醒时间顺序排序,使用 -s
选项按设置提醒的先后顺序排序
当在群聊中触发此指令时,仅返回在群聊内设置的提醒。
当在私聊中触发此指令时,返回所有私聊和群聊中设置的提醒。
注意:当配置环境变量 private_list_all=false
时,私聊时也仅返回私聊中设置的提醒。
此命令只会输出设置的循环提醒任务,不支持 -s
选项的排序,默认按照设置顺序排序。
使用的列表顺序默认按提醒时间顺序排序,使用 -s
选项按设置提醒的先后顺序排序的序号删除
注意:在删除提醒之前一定要先通过
/提醒列表
指令查看序号!每次删除后后续序号都会更新!
示例:
/删除提醒 1
:删除序号为1的提醒(默认按提醒时间排序)/删除提醒 -s 1-3 5
:批量删除序号为1、2、3、5的提醒(按设置时间排序)/删除提醒 all
:一键删除所有提醒(仅当前群聊)
与 /删除提醒
命令用法相同,同样不支持 -s
选项排序,必须提供由 /循环提醒列表
命令查看得到的任务序号。
提醒关键词示例图 | 提醒命令示例图 | 提醒列表命令示例图 | 删除提醒命令示例图 |
---|---|---|---|
![]() |
![]() |
![]() |
![]() |