#bot #qq #mirai

miraie

基于 mirai 和 mirai-api-http 的 QQ 机器人框架

14 releases

Uses new Rust 2021

0.2.0-beta.2 Nov 13, 2021
0.2.0-beta.1 Nov 12, 2021
0.1.11 Jul 16, 2021

#8 in #bot

Download history 24/week @ 2021-08-16 12/week @ 2021-09-13 12/week @ 2021-09-27 24/week @ 2021-10-11 1/week @ 2021-11-01 62/week @ 2021-11-08 8/week @ 2021-11-15 8/week @ 2021-11-22

79 downloads per month

AGPL-3.0

95KB
2K SLoC

miraie 未来へ

Build docs Crates.io

Miraie 是一个基于 miraimirai-api-http 的 Rust 机器人框架。

特性

  • 灵活、自然的对话式写法
  • 基于 mirai-api-http,可基于 docker 灵活部署
  • 支持 rustls,编译出的机器人可不依赖于 openssl

Demo

use miraie::prelude::*;
use anyhow::*;
use futures::*;

#[tokio::main]
async fn main() -> Result<()> {
    let (bot, con) = miraie::Bot::new("127.0.0.1:18418", "VERIFY_KEY", QQ(123456)).await?;

    // 可以直接使用 `command` 注册指令,可以直接返回字符串以进行回复
    bot.command("你好", |_: GroupMessage| async { "你好" })
        // 返回值也可以是 `Result<String>` 以更方便地处理错误
        .command("在吗", |_: GroupMessage| async {
            Result::<&'static str>::Ok("嗯嗯")
        })
        // 或者通过在函数参数中声明一个 `Bot` 以手动调用 `Bot` 的 `reply` 接口
        .command("在干什么", |msg: GroupMessage, bot: Bot| async move {
            msg.reply("你有事吗", &bot).await?;
            Result::<(), Error>::Ok(())
        })
        // 除了 command 接口,还有 handler 接口,下面的几个例子 **可以** 对所有的事件都进行注册,不会被关键词过滤
        // ping pong 服务对群聊和私聊都进行注册
        .handler(ping_pong_handler::<GroupMessage>)
        .handler(ping_pong_handler::<FriendMessage>)
        .handler(on_group_msg_confirm);

    // 取消注释下面一行以运行bot
    // con.run().await?;
    Ok(())
}

/// 实现一个最简单的 ping-pong 服务,它会对消息 ping 回复 pong,并在五秒后撤回该 pong。
async fn ping_pong_handler<T: Conversation>(msg: T, bot: Bot) -> Result<()> {
    if msg.as_message().to_string().trim() == "ping" {
        let resp = msg.reply("pong", &bot).await?;
        // 五秒后撤回
        tokio::time::sleep(std::time::Duration::from_secs(5)).await;
        bot.request(api::recall::Request {
            message_id: resp.message_id,
        })
        .await?;
        return Ok(());
    }
    Ok(())
}

/// 这个例子说明了交互式的对话是怎么进行的。该 handler 只对群聊消息生效。
///
/// 消息过程:
/// ```text
///                                     复读一下 <
/// > 真的要复读吗?请在 10 秒内进行确认
///                                        确认 <
/// > 确认成功,复读下一句
///                                Are you ok? <
/// > Are you ok?
/// ```
async fn on_group_msg_confirm(group_msg: GroupMessage, bot: Bot) -> Result<()> {
    if group_msg.message.to_string() == "复读一下" {
        let next_msg = group_msg
            .prompt("真的要复读吗?请在 10 秒内进行确认", &bot)
            .await?;

        if next_msg.message.as_confirm() == Some(true) {
            group_msg.reply("确认成功,复读下一句", &bot).await?;
            log::info!("开始复读,等待下一句");
            // 等待下一句
            let mut next = group_msg
                .followed_sender_messages(&bot)
                .next()
                .await
                .context("连接断开了哦")?;
            log::info!("复读这一句话:{:?}", next);
            // 进行一个读的复
            let msg = next.message.take();
            next.reply_unquote(msg, &bot).await?;
        } else {
            group_msg.reply("确认失败", &bot).await?;
        }
    }
    Ok(())
}

上面的机器人完整代码可以在 simple_bot.rs 示例代码 中找到。

一个更完整的、带有管理员、配置文件的机器人示例可以在 avabot 找到。

Rust features

native-tls

使用 native tls 作为 backend

rustls

使用 rustls 作为 backend

后续规划

  • 更多提取器(AtMe,UserAt,Keyword)
  • 补全 Approve trait

运行时需要提供的环境变量

  • MIRAIE_RESOURCE_ROOT:资源的根目录,这个需要是 mirai 运行时的目录。如果 mirai(Java)运行在机器 A 上,基于 miraie 的 rust bot 运行在机器 B 上,这个需要是机器 A 上的路径。

Dependencies

~9–14MB
~293K SLoC