simbot-component-qq-guild
simbot-component-qq-guild copied to clipboard
一个基于 Kotlin 协程对QQ频道机器人API 进行实现的 API/SDK Kotlin 多平台库,Java 友好、高效异步,同时也是 Simple Robot 的组件库实现之一 😻😻😽
这是一个基于 Kotlin coroutines 对 QQ频道机器人 进行实现的 API/SDK Kotlin 多平台库,异步高效、Java友好。
它同样是一个 Simple Robot v4 (下文简称 simbot) 的组件库,是 simbot 的子项目之一。 借助 simbot 核心库提供的能力,它可以支持更多高级功能和封装,比如组件协同、Spring支持等。
它可以作为一个低级别的 API/SDK 辅助依赖库, 也可在 simbot 核心库的支持下用作为一个轻量级的快速开发框架!
序列化和网络请求相关分别基于 Kotlin serialization 和 Ktor.
文档与引导
- QQ频道组件手册: 应用手册 (即当前仓库的 GitHub Pages)
- 了解simbot: Simple Robot 应用手册
- 文档引导站&API文档
- 社群 文档中也有提供社群信息喔
- 前往 组织首页 了解更多有关组件、文档、以及社群等相关信息!
我们欢迎并期望着您的 反馈 或 协助, 感谢您的贡献与支持!
模块引导
API模块
基于 Ktor
针对 QQ频道API
的基本完整的KMP多平台封装实现,
是一个简单高效轻量级的API实现模块。
此模块基本不会提供什么多余的实现,其目标为在提供封装的情况下尽可能地保留原始API的使用手感,不做过多的封装。
👉 前往模块 了解更多。
标准库模块
基于 API模块 针对bot的"登录"鉴权实现简单高效轻量级的事件订阅功能。
此模块在API模块的基础上提供了针对事件相关的功能实现,包括事件订阅的能力。 同样的,其目标为在提供封装的情况下尽可能地保留原始API的使用手感,不做过多的封装。
👉 前往模块 了解更多。
核心组件模块
基于 标准库模块 对 simbot4核心库 的组件实现, 是一个相对高度封装的模块,并提供simbot4大部分能力,包括事件监听、多组件协同、Spring Boot Starter 等。
👉 前往模块 了解更多。
法欧莉!
如果你想看一看使用QQ频道组件实现的具体作品, 可以前往QQ频道添加亲爱的 法欧莉斯卡雷特 来体验喔~
License
simbot-component-qq-guild
使用 LGPLv3
许可证开源。
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/>.