Skip to main content

简介

本项目的 Github 页:YiriMiraiProject/Trigger

事件触发器有什么用?

如果大家用过 Graia Framework,那么应该知道一个非常实用的功能:中断。它可以实现这样的效果:

聊天记录
忘忧北萱草
忘忧北萱草
执行命令 command
Yiri
Yiri
发送 /confirm 以确认。
忘忧北萱草
忘忧北萱草
/confirm
Yiri
Yiri
命令 command 执行成功。

又或者,需要对接收到的事件进行过滤和解析,比如只接受斜杠开头的消息:

聊天记录
忘忧北萱草
忘忧北萱草
command
忘忧北萱草
忘忧北萱草
/command
Yiri
Yiri
命令 command 执行成功。

这些场景,事件触发器都可以满足你的需要。

安装

从 PyPI 安装:

pip install yiri-mirai-trigger
# 或者使用 poetry
poetry add yiri-mirai-trigger

安装之后,事件触发器将在 mirai_extensions.trigger 模块中。

使用

事件触发器提供了中断控制器事件接收控制器,分别处理上面提到的两种场景。

具体的使用方式,请看后续的文档。

API 文档

本项目的 API 文档见这里