💡核心仓库 | 官网 | 🏠社区
> 感谢 CatCode 开发团队成员制作的simbot logo <
> 走过路过,不要忘记留下闪亮亮的⭐喔~ <
一个bot风格的高效异步事件调度框架 / A Bot-style event scheduling framework, asynchronous and high-performance
Simple Robot
v4 是一个基于 KMP 的多平台 Bot 风格高性能异步事件调度框架(下文简称simbot),
提供统一的异步API和易用的风格设计,可以协助你更快速高效的编写 Bot 风格的事件调度应用。
目前主要应用于对接各种类型的 Bot 应用平台/框架,并提供部分组件库实现。
simbot
通过 Kotlin 语言开发、
基于 KMP 支持多平台,
并兼容Java(jdk11+)等JVM平台语言,
且提供大量 Java 友好 API 和 Spring Boot starter,协助你快速开发!
核心库是所有组件的前置、标准API的制定者、也是绝大多数统一功能实现的地方。👉前往核心库
Kotlin & simbot-core
suspend fun main() {
val application = launchSimpleApplication {
findAndInstallAllPlugins(true)
findAndInstallAllComponents(true)
}
application.listeners {
// 事件监听
process<FriendMessageEvent> { event -> // this: EventProcessingContext
event.reply("Hello, Simbot")
}
}
application.join()
}
Java & Spring Boot
@SpringBootApplication
@EnableSimbot // 启用simbot
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
// 可以选择阻塞、异步或响应式等多种不同风格的 Java API
// 前排提醒:这里仅供示例,不建议混用多种风格,尤其是阻塞和异步混用。
/** 事件监听,监听一个通用的标准事件类型 */
@Listener
public void onFriendMessage(ChatChannelMessageEvent event) {
event.replyBlocking("Hello, Simbot!");
}
/**
* 假设:你在使用Telegram组件,那么此处为监听 Telegram 的普通群消息事件
* 并且这里以 reactor API 为例
*/
@Listener
public Mono<?> onTelegramChatGroupMessage(TelegramChatGroupMessageEvent event) {
return event.replyReserve("Hello, Simbot!").transform(SuspendReserve.mono());
}
/**
* 假设:你在使用KOOK组件,那么此处为监听KOOK的聊天子频道消息事件
* 并且这里以 Java async API 为例
*/
@Listener
public CompletableFuture<?> onKookChannelMessage(KookChannelMessageEvent event) {
return event.replyAsync("Hello, Simbot!");
}
}
👉 展开查看 Discord
Discord: 点击加入Discord
✨除了前往社群,一同建设 社区 是我们最推荐的相互交流的方式。如果你发现了一些问题,也可以通过 Issues 进行反馈。 与他人交流,并留下你的足迹吧!
是一个不仔细看的坏孩子呢。文档的话,在最上面的 官网 就是喔。核心库的API文档(KDoc)也可以在那里面找到。
当然,我们也提供了一个 文档引导站点 供你选择。
你也许可以去 这个B站视频 的所属合集中看看。
你有在使用simbot吗? 通过为你的仓库 添加 simbot
主题 来告诉我们吧!
体验如何?到 👉这个投票帖 来分享一下你的使用体验吧 ( •̀ ω •́ )✧
组件 | 手册 | API文档 | 版本参考 |
---|---|---|---|
QQ频道组件 | 📕前往手册 | API文档 | |
KOOK(开黑啦)组件 | 📕前往手册 | API文档 | |
🚧 OneBot组件 | 📕前往手册 (暂无,待建设) | API文档 | |
🚧 Telegram组件 | 📕前往手册 (暂无,待建设) | API文档 | |
🚧 Discord组件 | 📕前往手册 (暂无,待建设) | API文档 | |
🚧 Kritor组件 | 📕前往手册 (暂无,待建设) | API文档 | |
⚠ mirai组件 濒危 | 📕前往手册 | API文档 | |
💀 |
📕前往手册 | API文档 |
除了直接使用组件开发应用,simbot也支持使用 Kotlin 开发任意的自定义组件。
我们从 simbot4 开始会持续提供一些用于开发组件库/插件库的模板项目,如果你感兴趣, 在阅读组件开发相关文档之余也可以试试它们喔!
开发模板
Warning
组件开发与应用开发不同,不要搞混喔。
模板项目不一定会更新的很及时,如果你有发现任何描述错误、落后的版本、错误的逻辑,也都欢迎为其提交 issue 或 pr,感谢您的协助!
如果你想要找核心库或者各个组件的 API Doc 或者文档地址的话,也许你可以去 📚 图书馆 看看~
⭐ 为你青睐的仓库贡献一枚star或参与到社区的活跃建设中就是对我们最大的鼓励与帮助!
⭐ 如果你希望参与项目的建设,欢迎通过PR对某一仓库进行贡献!
⭐ 我们的开发团队生产力非常低,因为人手总是不足。如果你也想要参与到我们的团队中来,欢迎通过邮箱、社区、QQ频道 或 QQ群 联系我们~
如果你喜欢 Simple Robot, 那么不妨前往核心库以及你所青睐的组件为它点个可爱的🌟~
你的支持就是最优质的更新动力,非常感谢❤️
powered by Star History