Skip to content

指南 ​

**从零把 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、带权限内部工具)+ 写插件该守的规矩动手写之前

写插件时随时查 接口参考;想改框架或排查底层行为,看 进阶。

基于 MIT + Apache 2.0 双协议发布