Skip to content

开始使用

本篇面向:刚把宿主跑起来的使用者。先确认能启动,再按你的目标选一条路线。

启动框架

bash
python main.py
# 也可以指定配置文件:python main.py D:\config\zcbot.yaml

看到类似输出表示启动成功:

==================================================
ZCBOT 框架 启动中...
==================================================
官方插件 [onebot_adapter] 已加载
官方插件 [scheduler] 已加载
官方插件 [session] 已加载
官方插件 [webui] 已加载
已加载 8 个用户插件: ['echo', 'help', ...]
框架启动完成,等待事件...

最后一行 框架启动完成,等待事件... 出现后,框架开始监听接入端连接(如果启用了接入端)和定时任务。启动日志同时写入 data/logs/zcbot.log

选一条路线

框架不绑定任何平台,三种常见用法任选:

路线说明需要接入端吗
对接聊天平台在 QQ / Telegram 等平台收发消息,跑你写的命令型插件需要,见 对接 IM 平台
纯定时服务到点自动执行任务(日报、健康检查、推送)不需要
HTTP 事件注入外部系统通过 HTTP 把事件推进框架,触发插件逻辑不需要(用 http_inject 官方插件)

只想收发消息? 跳到 对接 IM 平台 把连接打通,回来发 /echo 你好 验证即可。

不接任何平台? 保持 core_plugins.yamlonebot_adapter.enabled: false,用定时任务或 HTTP 注入即可。例如开启 http_inject 后向 http://127.0.0.1:8901/hook POST 一个事件 JSON,就能触发 message 类插件逻辑,方便做自动化与联调。

第一次对话(已对接平台时)

在接入的平台上向机器人发送:

/echo 你好

机器人回复 你好 即链路正常。/help(或 /帮助/菜单)可查看命令列表。

Web 管理面板

浏览器访问 http://127.0.0.1:8080(地址端口以 core_plugins.yaml → webui 为准),默认账号:

  • 用户名:admin
  • 密码:admin123

面板里可以:启用 / 禁用 / 重载插件、管理命令与定时任务、管理用户 / 群组权限、查看仪表盘与日志、在线编辑插件配置。

首次登录必做

登录后立即到个人设置修改默认密码;若面板需要公网访问, 把 web.host 保持在 127.0.0.1 并通过反向代理暴露,同时设置好接入端的 access_token 与 IP 白名单。

下一步

基于 MIT + Apache 2.0 双协议发布