Simple Robot Projects

- 🎉 欢迎！ -

~ Simple Robot Framework ~
💡核心仓库 | 官网 | 🏠社区
> 感谢 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 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!");
    }
}

社群 / Communities

👉 展开查看 QQ群

群号：点击加入 185375305

$S9YOY3DF{5CGIZIKNVIM~70_tmb$

👉 展开查看 QQ频道

QQ频道：点击加入QQ频道

👉 展开查看 Discord

Discord: 点击加入Discord

✨除了前往社群，一同建设社区是我们最推荐的相互交流的方式。如果你发现了一些问题，也可以通过 Issues 进行反馈。与他人交流，并留下你的足迹吧！

🤔 猜你感兴趣

文档/API文档

是一个不仔细看的坏孩子呢。文档的话，在最上面的官网就是喔。核心库的API文档（KDoc）也可以在那里面找到。

当然，我们也提供了一个 文档引导站点 供你选择。

教学视频

你也许可以去这个B站视频的所属合集中看看。

🙋 你在吗？

你有在使用simbot吗? 通过为你的仓库添加 simbot 主题来告诉我们吧!

🐾体验如何？

体验如何？到 👉这个投票帖 来分享一下你的使用体验吧 ( •̀ ω •́ )✧

组件库

组件	手册	API文档
QQ频道组件	📕前往手册	API文档
KOOK(开黑啦)组件	📕前往手册	API文档
🚧 Telegram组件	📕前往手册 (暂无，待建设)	API文档
🚧 Discord组件	📕前往手册 (暂无，待建设)	API文档
🚧 OneBot组件	📕前往手册 (暂无，待建设)	API文档
🚧 Kritor组件	📕前往手册 (暂无，待建设)	API文档
⚠ mirai组件濒危	📕前往手册	API文档
💀 ~~米游社组件~~ 已逝	📕前往手册	API文档