指南
**从零把 ZCBOT 跑起来,到写出第一个插件。**按顺序读即可——前四篇是"跑起来",后五篇是"写业务"。
官方扩展大部分默认关闭(例外:
echo/help/scheduler/webui默认开启)。要哪种能力就启用哪个扩展(core_plugins.yaml里改enabled: true, 或python tools/scan_core_plugins.py --enable <名>),重启生效。 进 Web 后台需启用webui,收发聊天消息需启用某个接入端。
入门
| 文档 | 解决什么问题 | 什么时候读 |
|---|---|---|
| 安装 | 装环境、拉依赖、搞清目录结构、升级。依赖装漏了不用慌,启动时会自动补 | 第一次跑 |
| 快速开始 | 确认启动成功 → 确定事件从哪来 → 验证链路 / 打开后台 | 装完第一步 |
| 配置系统 | 两份 yaml 各管什么、改端口、开关插件、换数据库、安全清单 | 要改任何配置 |
| 对接 IM 平台 | 连上真实聊天软件收发消息:反向 WS、多平台接入、发图片 / @ / 群管 | 要接 QQ / TG / Discord |
开发插件
| 文档 | 解决什么问题 | 什么时候读 |
|---|---|---|
| 编写插件 | 跟着把「每日签到」写完,走通插件开发完整链路(命令、配置、定时任务、事件) | 写第一个插件 |
| 多轮会话 | 一问一答要接得上号:wait_for / create_session(依赖 core_plugins.session,默认关闭需先启用) | 做问卷、分步引导 |
| 接入大模型 | 让模型理解意图并调用你的函数:模型提供商总线、函数(工具)调用、Agent 循环 | 接 AI 对话 |
| 接入端契约 | 为什么插件不需要知道消息来自哪个平台:消息段跨协议统一、能力自述、通知事件命名 | 写跨协议插件 |
| 最佳实践 | 不依赖聊天软件的三种用法(纯定时、HTTP Webhook、带权限内部工具)+ 写插件该守的规矩 | 动手写之前 |