Makabaka 2.0.0-preview.2.241029.1

<div align="center">

<img width="160" src="logo.jpg" alt="logo">

Makabaka

一个基于 OneBot-11标准 的、适配于 Lagrange.Onebot 的、C# .NET Standard 2.1 的异步机器人开发框架。

</div>

说明

[!WARNING] 目前正在重构 Makabaka 2.0，绝大部分代码都使用 DI 进行了重构，因此调用逻辑与 1.x 差异较大。如果你从 1.x 迁移到 2.0 ，可能需要改动较多代码。

本项目将持续跟进 Lagrange.Core 项目进度。由于 Lagrange.Core 项目仍在开发当中，可能有部分功能暂未支持。
如果对该项目有任何问题，欢迎在 Issues 中提出。

安装

Makabaka 已发布到 NuGet ，可以通过NuGet包管理器搜索并安装到工程。
或者，可以直接去 Releases 中下载 .nupkg 文件。

已适配内容

<Details> <Summary>消息类型</Summary>

</Details>

<Details> <Summary>API</Summary>

</Details>

<Details> <Summary>事件</Summary>

</Details>

<Details> <Summary>适配器</Summary>

</Details>

<Details> <Summary>拓展功能</Summary>

</Details>

快速上手

配置文件

{
	"Logging": {
		"LogLevel": {
			"Default": "Information" // 日志等级，如果需要看到详细的收发数据包内容（例如提出 issue），请改成 Trace ，一般情况下用 Information 就行
		}
	},
	"Bot": {
		"ForwardWebSocket": { // 正向 WebSocket
			"Enabled": true, // 是否启用。注意：一般情况下 ForwardWebSocket 与 ReverseWebSocket 同一时间只能存在一个
			"Url": "ws://127.0.0.1:8081", // 远程 Lagrange.Onebot 的 ws 服务器地址
			"AccessToken": "", // 鉴权密钥
			"ReconnectInterval": 1000,
			"ConnectionTimeout": 5000,
			"ApiTimeout": 10000
		},
		"ReverseWebSocket": { // 反向 WebSocket
			"Enabled": false, // 是否启用
			"Url": "http://127.0.0.1:8082/onebot/v11/ws/", // 本地开启的 ws 服务器地址
			"AccessToken": "", // 鉴权密钥
			"RestartInterval": 1000
		}
	}
}

无注释版本见 appsettings.json 。

代码

using Makabaka;
using Makabaka.Events;
using Makabaka.Messages;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

namespace MyApp
{
	internal class Program
	{
		private static ILogger<Program> _logger = null!;

		static void Main(string[] args)
		{
			var builder = new MakabakaAppBuilder(args);
			var app = builder.Build();

			_logger = app.Services.GetRequiredService<ILogger<Program>>();
			app.BotContext.OnPrivateMessage += OnPrivateMessage;
			app.BotContext.OnGroupMessage += OnGroupMessage;

			app.Run();
		}

		private static Task OnPrivateMessage(object sender, PrivateMessageEventArgs e)
		{
			return OnMessage(e.Message, e);
		}

		private static Task OnGroupMessage(object sender, GroupMessageEventArgs e)
		{
			return OnMessage(e.Message, e);
		}

		private static async Task OnMessage(Message message, IMessageHandler reply)
		{
			if (message.ToString() == "文本测试")
			{
				await reply.ReplyAsync([new TextSegment("Hello, world!")]);
			}
		}
	}
}

开源协议

GPL-3.0 license

特别声明

• 本项目完全免费，仅供学习、娱乐使用，请勿运用于商业、非法用途。
• 因使用者使用不当而造成的法律责任，由使用者本人承担。