~ Simple Robot Framework ~

简介

Why simbot?

开始使用

核心库

组件库

积极反馈！

走马观花

suspend fun main() {
 val application = launchSimpleApplication {
 findAndInstallAllPlugins(true)
 findAndInstallAllComponents(true)
 }
 
 application.listeners {
 // 事件监听
 process<ContactMessageEvent> { event -> // this: EventProcessingContext
 event.reply("Hello, Simbot")
 }
 }
 
 application.join()
}

@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<Void> onTelegramChatGroupMessage(TelegramChatGroupMessageEvent event) {
 return event.replyReserve("Hello, Simbot!").transform(SuspendReserve.mono()).then();
 }

 /**
 * 假设：你在使用KOOK组件，那么此处为监听KOOK的聊天子频道消息事件
 * 并且这里以 Java async API 为例
 */
 @Listener
 public CompletableFuture<?> onKookChannelMessage(KookChannelMessageEvent event) {
 return event.replyAsync("Hello, Simbot!");
 }
}

// 单个消息元素
val text = "你好".toText()
val at = At(123456.ID)
// 组装消息链
val messages = text + at
// 构建消息链
val built = buildMessages {
 +"你好"
 +at
 +Face(666.ID)
}

// 单个消息元素
var text = Text.of("你好");
var at = new At(Identifies.of(123456));
// 组装消息链
var messages = Messages.of(text, at);
// 构建消息链
var built = MessagesBuilder.create()
 .add("你好")
 .add(at)
 .add(new Face(Identifies.of(666)))
 .build();

Note

针对不同的平台，各组件还可能会提供更多组件专属的消息元素类型，比如QQ频道中的 Ark 或 markdown 等。

社群 / Communities

🤔 猜你感兴趣

文档/API文档

教学视频

🙋 你在吗？

组件库开发

Warning

组件开发与应用开发不同，不要搞混喔。

模板项目不一定会更新的很及时，如果你有发现任何描述错误、落后的版本、错误的逻辑，也都欢迎为其提交 issue 或 pr，感谢您的协助！

📚 图书馆

🤝 协助我们

✨ 贡献星星！