本项目采用 AGPL-3.0 协议开源,详情请参阅 LICENSE 文件。
Copyright (C) 2024-2026 ProjectCoral and contributors.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-
AGPL-3.0协议属于传染性协议,因此建议直接/间接接触 Coral 项目的软件使用AGPL-3.0开源 -
本项目不建议用于商业用途。
-
若引用 Coral 发布的软件包而不修改 Coral 源码,请在软件包的
README中声明 Coral 项目的链接。 -
若修改 Coral 源代码再发布,或参考 Coral 内部实现发布另一个项目,则衍生项目必须在文章首部或 Coral 相关内容首次出现的位置明确声明来源于本仓库。不得扭曲或隐藏免费且开源的事实。
Coral 是一个跨平台、可扩展的 Python 机器人框架,Coral 基于事件驱动,使用异步 IO,能够为你的需求实现提供便捷灵活的支持。
Coral 项目已经内置了不少有用的方法和插件,它可以帮助你快速开发出一个功能丰富、可扩展的机器人。
- 跨平台支持
- 插件化架构
- 事件驱动模型
- 权限管理系统
- 多平台适配器(OneBot V11、Console等)
- 多Bot管理(一个平台可连接多个账号)
- 丰富的消息类型支持
Important
在2025/6/8的更新中,完全重构了 Coral 框架,并引入事件总线、适配器和驱动器。这将导致部分文档/插件失效,请见谅。
在2026/1/31后,Coral 框架引入 Protocol v3 和 过滤器 ,为插件开发提供了更好的体验。
如果你希望快速部署一个 Coral 机器人,安装插件、并投入使用,请看这里:快速部署
- 用户手册: UserManual
- 插件开发: PluginDev
有关更多插件,请访问 Coral 插件库。
-
开发文档: DevManual
-
参与贡献: Contributing
-
版本发布: Release
-
Coral 开发组和官方系列项目: Official
Onebot11 协议 OneBot
文档参考 mirai
实现参考 nonebot2
Star History:
