README_CN.md

~ Simple Robot ~
Discord 组件

---

中文 | English

Caution

WIP

这是 Simple Robot v4 下的子项目，是针对 Discord Bot 各方面的 simbot 组件库实现， 包括对 API 内容的实现、事件相关的实现以及BOT对于事件的监听与交互等。

Discord Component 可以作为底层API依赖使用、 轻量级的 Discord 事件调度框架使用， 也可以基于 simbot 核心库的种种快速开发一个功能强大的 Discord Bot！

• 基于 Kotlin 提供 KMP 多平台 特性，并提供 Java 友好的API。
• 基于 Kotlin coroutines 与 Ktor 提供轻量高效的API。

Note

下文中 Simple Robot v4 简称为 simbot4

文档

• Discord组件手册：(待建设)
• 了解simbot: Simple Robot 应用手册
• API文档: 文档引导站点 中 Discord 的 KDoc站点
• 社群: 与我们和其他开发者愉快地交流！

模块引导

API模块

基于 Ktor 针对 Discord API 的基本完整的KMP多平台封装实现， 是一个简单高效轻量级的API实现模块。

此模块基本不会提供什么多余的实现，其目标为在提供封装的情况下尽可能地保留原始API的使用手感，不做过多的封装。

👉 前往模块 了解更多。

标准库模块

基于 API模块 针对 bot 的鉴权、事件订阅等功能的实现。

同样的，其目标为在提供封装的情况下尽可能地保留原始API的使用手感，不做过多的封装。

👉 前往模块 了解更多。

核心组件模块

基于 标准库模块 对 simbot4核心库 的组件实现， 是一个相对高度封装的模块，并提供simbot4大部分能力，包括事件监听、多组件协同、Spring Boot starter 等。

👉 前往模块 了解更多。

贡献

前往 贡献指南 了解更多！

我们欢迎并期望着您的 反馈 或 协助， 感谢您的贡献与支持！

License

simbot-component-discord 使用 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/>.