README.md
March 24, 2026 · View on GitHub
~ Simple Robot ~
OneBot Component
Simple Robot OneBot 组件是一个 OneBot11 协议的客户端SDK，是基于 Simple Robot 标准API实现的组件库， 提供simbot中的各项能力。
它是一个 Kotlin 多平台 库，Java 友好、异步高效！
借助simbot核心库提供的能力，它可以支持很多高级功能和封装，比如组件协同、Spring支持等， 祝你快速开发 OneBot 客户端应用！
序列化和网络请求相关分别基于 Kotlin serialization 和 Ktor。
Important
为了方便代码管理，我们正在陆续将一些较为成熟的组件库合并到 核心库 中一同管理。 因此，本仓库的内容将会直接合并到 核心库 的 simbot-component-onebot 目录下维护，并与核心库 共享版本号，也就是从下一个大版本开始，本组件的版本将会跟随核心库一起进入 5.x 版本。
除了其他原本就在计划内的内容更新之外，其他的信息（例如 Maven 仓库的路径、包路径等）均保持不变，迁移就只是改个版本号的事儿~
本仓库会继续保留并维护当前的 1.x 版本直到 5.x 正式推出，之后会进入归档状态。
文档与引导
- 手册：Simple Robot 应用手册 与手册内的 OneBot组件 部分。
- 文档引导站 & API文档
- 社群 (文档中也有提供社群信息喔~)
- 组织库首页: 了解更多有关组件、文档、以及社群等相关信息！
我们欢迎并期望着您的 反馈 或 协助， 感谢您的贡献与支持！
快速开始
前往手册 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 |
> RawGroupIncreaseEvent 或 RawGroupDecreaseEvent | > 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 |
其中，可以通过 OneBotUnsupportedEvent 和 OneBotUnknownEvent
来间接地监听那些尚未提供组件事件类型的原始事件。
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/>.