快速使用

June 12, 2025 · View on GitHub

安装

1. 自动安装

项目内置了自动安装脚本install_env.bat,只需运行即可完成安装

或是运行以下命令:

.\install_env.bat

2. 手动安装

项目依赖于以下环境:

  • Python 3.6+
  • git 2.xx+

在安装 Python 3.6+ 后,拉取项目代码到本地:

git clone https://github.com/ProjectCoral/Coral.git

进入项目根目录,安装依赖:

cd Coral
pip install -r requirements.txt <-i https://pypi.tuna.tsinghua.edu.cn/simple/>

启动项目:

python main.py

至此,Coral 项目已经成功安装,接下来需要接入平台。

接入

Coral 项目支持多种接入方式,只需注册函数并调用即可做到在任意平台使用。

对于 企鹅 平台, Coral 项目目前原生支持反向websocket Reverse_websocket 接入。你需要下载可用的 Onebot11 适配器(如LLOnebotLagrange.Core),配置 config.json 文件中的 websocket_port 即可。


至此,Coral 项目已经可以正常运行,你可以通过添加插件来扩展功能。更多详情请参阅用户手册