Skip to content

快速开始

1. 环境要求

2. 下载

从发布页下载最新版 Bngeuit.jar

3. 目录结构

my-bot/
├── Bngeuit.jar         # 核心
├── config.yml          # 机器人配置(自动生成)
├── plugins/            # 插件目录(自动创建)
│   └── MyPlugin.jar    # 放入插件 JAR 即可加载
├── media_files/        # 本地媒体文件目录(可选,供 ByFile 分片上传使用)
├── markdown_files/     # 本地 Markdown 文件目录(可选,供 getMarkdownContent 使用)
└── logs/               # 日志目录

4. 配置

启动一次后会在运行目录生成 config.yml,填入你的凭据:

yaml
bot:
  appId: "你的BotAppID"
  appSecret: "你的BotAppSecret"

  # 事件接入方式二选一:websocket(默认,网关长连接)| webhook(HTTP 回调)
  # mode: websocket
  # webhook 模式配置(mode: webhook 时生效):
  # webhook:
  #   host: "0.0.0.0"        # 回调监听地址
  #   port: 8080             # 回调端口(官方限定 80/443/8080/8443)
  #   path: "/"              # 回调路径(开放平台回调地址 = 公网地址 + 路径)
  #   verifySignature: true  # 校验事件签名(默认 true,生产必须开启)

  # 可选配置(均有默认值,按需取消注释)
  # timeout: 5            # HTTP 请求超时(秒),默认 5
  # sandbox: false        # 是否使用沙箱环境,默认 false
  # retCoroutine: false   # 协程模式,默认 false

5. 启动

bash
java -Dfile.encoding=UTF-8 -jar Bngeuit-x.x.x.jar

推荐加低内存参数(2G 服务器 + 脚本插件场景;不使用脚本插件时 -Xmx256m 可调小到 128m):

bash
java -Xms32m -Xmx256m -XX:+UseSerialGC -XX:MaxMetaspaceSize=96m -Dfile.encoding=UTF-8 -jar Bngeuit-x.x.x.jar