Skip to content
EasybotCEPublic

About

EasybotCE 的主程序

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

EasybotCE Core

EasybotCE 的主程序,使用 Go 提供管理 API、Vue 3 提供网页管理台,默认使用 SQLite 保存数据。便携包包含程序和页面资源,解压后即可运行。

文档导航

当前进度

功能 状态
管理台、配置管理、登录认证、持久化运行日志 已实现
OneBot 11 正向 WebSocket 适配器 已实现连接、消息收发接口、状态管理与断线重连;已通过协议模拟器验证,真实账号仍待验收
MySQL、PostgreSQL 存储 已提供实现和集成测试;具体版本以对应 CI 验证结果为准
Minecraft 桥接、消息转发、账号绑定 尚未实现
JavaScript 插件执行、AI 对话、图片模板渲染 尚未实现;已有配置入口不代表运行能力可用

后续范围和验收标准见 开发计划。

快速开始

  1. 从 发布版本 下载适合当前系统的便携压缩包。
  2. 解压到可写目录,保留包内的 web 目录。
  3. Windows 双击 easybotce.exe;Linux 在解压目录运行 ./easybotce,缺少执行权限时先执行 chmod +x easybotce。
  4. 浏览器打开 http://127.0.0.1:5001,运行期间保持程序窗口或终端打开。

默认仅监听本机回环地址,无需注册或登录。普通用户不需要安装 Go、Node.js、数据库服务器,也不需要额外启动前端服务。

Windows 双击启动失败时会显示错误原因,按回车后关闭窗口;从已有终端或自动化任务启动时,程序直接返回错误码。

配置与登录

便携包自带 appsettings.json;文件缺失时首次启动会生成默认配置。修改配置后需重启,程序不会重写已有配置文件。

配置项 用途与默认值
Kestrel.Endpoints.web_api.Url 管理台及 API 地址,默认 http://127.0.0.1:5001
ServerOptions.Host、ServerOptions.Port 桥接地址,默认 127.0.0.1:26991;桥接运行时尚未实现,当前不监听
Database.SQLitePath SQLite 数据库路径,默认 appdata/easybot.db
Serilog.MinimumLevel.Default 控制台日志级别
AllowedHosts 允许的请求主机名,支持 *、分号分隔的主机名及 *.example.com

改为非本地地址监听后,管理台使用登录令牌(Token)认证,无需用户名或独立 API Key。非本地模式缺少 token.txt 时,程序会自动生成 12 位令牌并在控制台显示一次;token.txt 只保存 SHA-256 哈希,之后继续使用原令牌。

忘记令牌时,先停止程序,再删除 token.txt,重启进入非本地模式后生成新令牌,旧登录会话随之失效。非本地监听支持 HTTP;通过公网传输凭据时建议使用 HTTPS。

EASYBOT_CONFIG 可指定配置文件,相关环境变量优先于 JSON 配置。完整配置项、HTTPS 示例和数据库接入方式见 开发说明,配置模板见 appsettings.example.json。

升级与原版迁移

升级便携包前先停止程序,备份并保留 appsettings.json、token.txt 和 appdata,再替换程序与 web 页面资源,避免用包内模板覆盖现有配置。已有 CE 数据库也可通过 EASYBOT_SQLITE_PATH 指定路径继续使用。

从原版迁移时,可将 appsettings.json 和已有的 token.txt 复制到 CE 程序旁。原有配置字段和端口按原值读取,CE 新增配置项缺失时使用默认值;同时运行两套程序时需避免端口冲突。原版 token.txt 是二进制哈希文件,不能用明文令牌替代。

复制启动配置不会导入原版数据库、适配器或插件数据,原版数据库需要单独迁移,不能直接替换 CE 数据库。旧版 CE 的用户名、密码登录已由令牌登录替代,已有业务数据保留。

源码开发

开发环境要求:Go 1.24+、Node.js 20.19+。在仓库根目录执行:

node build.mjs

脚本自动安装前端依赖、构建页面、编译程序并生成便携包:Windows 输出 release/easybotce-windows-amd64.zip,Linux 输出对应平台的 .tar.gz;本地编译程序同时保存在 dev/bin。

手动运行、热更新和测试命令见 开发说明,前端开发见 管理台说明。CI 包含跨平台测试、静态检查、便携包构建和数据库集成测试。

贡献者和开发代理须遵守 贡献规范 与 协作约定。建议使用中文说明 PR 和提交;中文 CI 仅提醒,不阻断合并。使用 AI 辅助贡献时须披露工具及用途,详细要求见贡献规范。

项目结构

路径 内容
dev/cmd/easybot/ Go 程序入口
dev/internal/ 配置、认证、存储、适配器和管理 API
dev/web/ Vue 3、TypeScript、Tailwind CSS v4 管理台
.github/workflows/ CI 工作流
PLAN.md 原始重建规划
REMAINING_PLAN.md 后续功能范围与验收标准

许可证与署名

本仓库使用 CC BY-NC 4.0(CC-BY-NC-4.0) 许可证,该许可证不允许商业使用。分享或改编时,请注明 EasybotCE 及本仓库来源,附上许可证链接、标明改动,并保留已有作者、版权和许可声明。详见 署名说明。

About

EasybotCE 的主程序

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages