simple-robot / simbot-component-onebot

一个Kotlin多平台的 OneBot SDK 实现,一个异步高效、Java 友好的 Simple Robot 组件库 ~ 🐱🐱🐱
https://simbot.forte.love/component-onebot.html
GNU Lesser General Public License v3.0
10 stars 3 forks source link
kotlin kotlin-coroutines kotlin-multiplatform kotlin-multiplatform-library onebot onebot-sdk onebot11 simbot simbot-component
simbot logo

~ Simple Robot ~
OneBot Component

release release

stars forks watchers repo size issues last commit copying

Simple Robot OneBot 组件是一个 OneBot11 协议的客户端SDK,是基于 Simple Robot 标准API实现的组件库, 提供simbot中的各项能力。

它是一个 Kotlin 多平台 库,Java 友好、异步高效!

借助simbot核心库提供的能力,它可以支持很多高级功能和封装,比如组件协同、Spring支持等, 祝你快速开发 OneBot 客户端应用!

序列化和网络请求相关分别基于 Kotlin serializationKtor

文档与引导


我们欢迎并期望着您的 反馈协助, 感谢您的贡献与支持!

快速开始

前往手册 OneBot组件部分 了解更多、 参考其中的开始使用OneBot11

事件关系

简单列举一下原始事件与可能对应的组件事件之间的关系。

原始事件类型 组件事件
RawMetaEvent OneBotMetaEvent
> RawLifecycleEvent > OneBotLifecycleEvent
> RawHeartbeatEvent > OneBotHeartbeatEvent
RawMessageEvent OneBotMessageEvent
> RawGroupMessageEvent > OneBotGroupMessageEvent
> RawGroupMessageEvent > > OneBotNormalGroupMessageEvent
> RawGroupMessageEvent > > OneBotAnonymousGroupMessageEvent
> RawGroupMessageEvent > > OneBotNoticeGroupMessageEvent
> RawPrivateMessageEvent > OneBotPrivateMessageEvent
> RawPrivateMessageEvent > > OneBotFriendMessageEvent
> RawPrivateMessageEvent > > OneBotGroupPrivateMessageEvent
RawRequestEvent OneBotRequestEvent
> RawFriendRequestEvent > OneBotFriendRequestEvent
> RawGroupRequestEvent > OneBotGroupRequestEvent
RawNoticeEvent OneBotNoticeEvent
> RawFriendAddEvent > OneBotFriendAddEvent
> RawFriendRecallEvent > OneBotFriendRecallEvent
> RawGroupAdminEvent > OneBotGroupAdminEvent
> RawGroupBanEvent > OneBotGroupBanEvent
> RawGroupIncreaseEventRawGroupDecreaseEvent > OneBotGroupChangeEvent
> RawGroupIncreaseEvent > > OneBotGroupMemberIncreaseEvent
> RawGroupDecreaseEvent > > OneBotGroupMemberDecreaseEvent
> RawGroupRecallEvent > OneBotGroupRecallEvent
> RawGroupUploadEvent > OneBotGroupUploadEvent
> RawNotifyEvent > OneBotNotifyEvent
> RawNotifyEvent > > OneBotHonorEvent
> RawNotifyEvent > > OneBotLuckyKingEvent
> RawNotifyEvent > > OneBotPokeEvent
> RawNotifyEvent > > > OneBotMemberPokeEvent
> RawNotifyEvent > > > OneBotBotSelfPokeEvent
UnknownEvent > UnknownEvent
OneBotBotStageEvent
> OneBotBotRegisteredEvent
> OneBotBotStartedEvent
任意未支持事件 OneBotUnsupportedEvent

其中,可以通过 OneBotUnsupportedEventOneBotUnknownEvent 来间接地监听那些尚未提供组件事件类型的原始事件。

License

This program is free software: you can redistribute it and/or 
modify it under the terms of the GNU Lesser General 
Public License as published by the Free Software Foundation, 
either version 3 of the License, or (at your option) 
any later version.

This program is distributed in the hope that it will be useful, 
but WITHOUT ANY WARRANTY; without even the implied 
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public 
License along with this program. 
If not, see <https://www.gnu.org/licenses/>.