快速开始
快速开始
本页说明如何在本地准备 Lingchu Bot。在连接到真实平台之前，请准备好 NoneBot 和已启用适配器所需的账号、网络和配置。QQ 平台默认启用 OneBot V11。Milky、QQ 和 OneBot V12 适配器已弃用并被完全移除。
环境要求
- Python 3.13
- uv
- git
- 已启用 QQ 适配器可用的运行环境；默认为 OneBot V11
安装步骤
获取代码
git clone https://github.com/xinvxueyuan/lingchu-bot.git
cd lingchu-bot运行初始化脚本
项目提供了跨平台初始化脚本，一键完成全部初始化流程：
chmod +x scripts/setup.sh
./scripts/setup.sh脚本将依次执行：
- 检测操作系统类型和必需工具链
- 验证 Python 3.13+、Node.js 20+、pnpm 9+、Git 和 uv
- 安装所有 Python 和 Node.js 依赖
- 生成环境配置文件（
.env、.env.development、.env.test、.env.production） - 配置 Git 钩子（husky）
- 可选初始化 Git 仓库和安装 Playwright 浏览器
详见 ./scripts/setup.sh --help。
选择运行方式
将本仓库作为本地插件目录加载到已有的 NoneBot 项目中。确保目标 NoneBot 项目加载了 src/plugins：
# 在 NoneBot 项目的 pyproject.toml 中
[tool.nonebot]
plugin_dirs = ["path/to/lingchu-bot/src/plugins"]仓库提供了 Docker 构建流程。Docker 镜像在构建阶段通过 nb-cli 生成运行用 /tmp/bot.py：
docker compose up --build启动前检查
- 确认 Python 版本为 3.13。
- 确认已启用适配器的服务和连接设置已就绪。
- 如果运行时注册了多个 QQ 适配器，Lingchu Bot 只启用
LINGCHUAdapter选择的业务代码；请确保选中的适配器也已被 NoneBot 加载。 - 确认目标 NoneBot 项目加载了
src/plugins，或者你正在使用仓库的 Docker 运行方式。 - 确认 NoneBot 配置中的布尔值使用小写
true/false，而非True/False。
布尔值格式
NoneBot 配置文件只接受标准 JSON 小写 true / false。使用 True / False 会在启动时抛出配置错误。
下一步
最后更新于