Mirai.Net 是基于mirai-api-http实现的轻量级mirai社区 sdk。 此项目遵循 AGPL-3.0 LICENSE 开源。
本项目的 QQ 群: 1042821169,需要技术支持或者有什么问题(甚至水群聊天),欢迎加入群聊探讨。
如果申请QQ群迟迟没有得到通过,可能是你的账号被腾讯风控,可以发邮件给我: AHpx@yandex.com 。
项目文档: https://sinoahpx.github.io/Mirai.Net.Documents
如果你觉得这是个很酷的项目的话,不妨考虑给它点一个Star,如果你还觉得挺酷但还不够好的话,也欢迎提交Pull Request和Issue。
- 基于 .NET Standard 2.0 开发,支持跨平台。
- 适配最新的mirai-api-http插件。
- 实现了mirai-api-http的
Http Adapter
和Websocket Adapter
Http Adapter
用来进行发送操作。Websocket Adapter
用来进行接收操作。
- 基于 Rx.NET 的推送系统。
- 有一堆好用的脚手架和拓展方法。
- 提供了简单的模块化和命令系统实现。
- 源代码结构
- Mirai.Net,主项目
- Mirai.Net.Test,控制台测试项目
- Mirai.Net.UnitTest,单元测试项目(现在没啥用了)
实现的接口列表
斜体的标注的接口是不稳定的
删除线标注的接口是未实现的
- 账号信息
- 获取好友列表
- 获取群列表
- 获取群成员列表
- 获取 Bot 资料
- 获取好友资料
- 获取群成员资料
- 获取陌生人资料
- 消息发送和撤回
- 发送好友消息
- 发送群消息
- 发送临时会话消息
- 发送头像戳一戳消息
- 撤回消息
- 根据消息id获取消息链
- 文件操作
- 查看文件列表
- 获取文件信息
- 创建文件夹
- 删除文件
- 移动文件
- 重命名文件
- 多媒体内容上传
- 图片文件上传
- 语音文件上传
- 群文件上传
- 账号管理
- 删除好友
- 群管理
- 禁言群成员
- 解除群成员禁言
- 移除群成员
- 退出群聊
- 全体禁言
- 解除全体禁言
- 设置群精华消息
- 获取群设置
- 修改群设置
- 获取群员设置
- 修改群员设置
- 事件处理
- 添加好友申请
- 用户入群申请
- Bot 被邀请入群申请
支持的消息类型
- Quote - 回复消息
- At - @消息
- AtAll - @全体成员
- Face - QQ 表情
- Plain - 纯文本
- Image - 图片
- FlashImage - 闪照
- Voice - 语音
- Xml - XML 消息
- Json - JSON 消息
- App - App 消息
- Poke - 戳一戳
- Dice - 不知道是啥玩意
- MusicShare - 音乐分享
- ForwardMessage - 转发消息
- File - 文件
- MarketFace - 商城表情
- MiraiCode - Mirai码
(以下仅为一些简单示例,如果需要更详细的说明,请移步文档。有时候文档跟不上版本请进群提问
- 使用 Nuget 安装(推荐)
- Nuget 包管理器:
Install-Package Mirai.Net
- .NET CLI:
dotnet add package Mirai.Net
- 或者在 IDE 的可视化界面搜索
Mirai.Net
安装最新版。
- Nuget 包管理器:
- 自己克隆这个仓库的默认分支,然后自己编译,然后自己添加 dll 引用。
名称空间引用
using System;
using System.Linq;
using System.Reactive.Linq;
using System.Threading;
using System.Threading.Tasks;
using Mirai.Net.Data.Messages;
using Mirai.Net.Data.Messages.Receivers;
using Mirai.Net.Sessions;
using var bot = new MiraiBot
{
Address = "localhost:8080",
QQ = "xx",
VerifyKey = "xx"
};
(因为MiraiBot
类实现了IDisposable
接口,所以可以使用using
关键字)
Address
和VerifyKey
来自mirai-api-http
的配置文件,QQ
就是Mirai Console
已登录的机器人的 QQ 号。
创建完MiraiBot
实例之后,就可以启动了:
await bot.LaunchAsync();
MiraiBot
类暴露两个属性: EventReceived
和MessageReceived
,订阅它们就可以监听事件和消息。
下面的例子就是过滤出接收到的好友请求事件
事件,然后把它从EventBase
转换成具体的NewFriendRequestedEvent
,最后才是订阅器。
(消息的订阅器也是同样的)
bot.EventReceived
.OfType<NewFriendRequestedEvent>()
.Subscribe(x =>
{
//do things
});
Mirai.Net
通过一系列的xxManager
(这些管理器都是静态类。)来进行主动操作,其中,消息相关的管理器为MessageManager
。
这里以发送群消息作为演示,实际上还可以发送好友消息,临时消息和戳一戳消息。
发送消息的方法有两个参数: 发送到哪里和发送什么。所以第一个参数就是发消息的群号,第二个参数就是要发送的消息链(或者字符串)。
await MessageManager.SendGroupMessageAsync("xx", "Hello, World");
或者:
await MessageManager.SendGroupMessageAsync("xx", new MessageChainBuilder().Plain("Hello, ").At("xx").Build());
此项目欢迎任何人的Pull Request 和Issue,也欢迎 Star 和 Fork。
如果你认为文档不够好,也欢迎对文档仓库提交Pull Request和Issue
- mirai
- mirai-api-http
- Jetbrains
- Flurl
- Json.NET
这甚至是这个项目名称的灵感来源 - Websocket.Client
- Rx.NET
- Manganese