Simple Robot | 米游社大别野组件 v0.2.0 Help

前言&简介

欢迎来到 Simple Robot (下文简称 simbot) 的米游社大别野机器人组件 (下文简称 大别野组件) 文档。

大别野组件是基于 simbot核心库米游社大别野机器人 的组件实现, 也包括对API和事件订阅能力的底层库实现模块。

大别野组件由 Kotlin 语言编写,不同的模块分别基于 KMP (Kotlin Multiplatform)Kotlin/JVM 构建。 在JVM平台上对 Java 友好,并基于 KMP 提供更多平台的可能性。

模块简介

simbot的大别野机器人组件整个项目分为三个主要模块。它们分别是 API模块stdlib(标准库)模块core(核心库)模块

API模块

API模块的主要作用是提供针对大别野机器人开发平台中的各API和事件类型的底层封装。 此模块 不提供 过度的功能性封装, 主要宗旨为在风格统一的情况下将API和事件 描述 为可供使用的依赖库。

stdlib 标准库模块

标准库模块依赖API模块,在此基础上额外提供大别野中 Bot 概念的封装与能力实现, 达到对一个 Bot 的事件订阅、消息发送等能力。 与API模块类型,标准库模块的主要宗旨同样是在风格统一的情况下将Bot与事件订阅的能力 描述 为可供使用的依赖库。

core 核心库

核心库模块是对 simbot核心库 的大别野机器人实现,也是此项目作为 “simbot组件” 的主要体现。

核心库模块依赖并实现 simbot API ,针对其定义的各类型来提供simbot风格的大别野组件实现。例如实现 simbot 提供的 Bot 类型为 VillaBot 并提供大别野组件下的各种独特能力。

核心库模块是一种高级封装,它会借助 simbot API 强大的能力来提供大量高级功能,例如对事件的订阅和更便捷的消息发送、对 Spring Boot 的支持等。

核心库模块会尽可能屏蔽掉底层API (上述两个模块),使其对开发者透明,取而代之的是更加清晰明了的API。

Last modified: 05 January 2024