micq

MICQ

一个面向 OneBot v11 的 Go 机器人框架，提供简洁一致的 API、高效可靠的运行时、方便扩展的插件机制。

快速开始

开始前需要准备：

• Git。
• Go 1.24 或更新版本。
• 一个 OneBot v11 正向 WebSocket 地址，例如 ws://127.0.0.1:3001。

新建一个目录作为机器人的家，例如 mybot。然后进入该目录。

mkdir mybot && cd mybot

从 Gitee Releases 下载适合自己系统的启动器，放到该目录里。以 Linux AMD64 为例，下载后目录结构如下：

mybot/
├── micq-linux-amd64

在 Linux 和 macOS 上，可以把启动器重命名为 micq，并赋予执行权限：

chmod +x micq-linux-amd64
mv micq-linux-amd64 micq

初始化

初始化框架：

./micq init

以上命令会在当前目录生成 run/，之后所有与 micq 相关的东西都在这里：

run/
├── .micq/         框架源码与构建缓存
├── config/        配置文件
├── plugins.lock   插件清单
└── data/          运行数据

想换个位置，给任意命令加 -workdir DIR 即可。

编辑 run/config/core.yaml，填入 OneBot 地址、允许使用机器人的群号、管理员 QQ 号：

onebot:
  url: ws://127.0.0.1:3001
  access_token: ""
  prefix: [/man]
  groups: [1919810]
  admins: [10086]

运行

./micq run

首次运行，启动器需要花几秒钟构建框架。以后运行就会使用缓存。

首次运行可能需要下载 Go 依赖，如果网络不好，请设置 GOPROXY：

go env -w GO111MODULE=on
go env -w GOPROXY=https://goproxy.cn,direct

MICQ 默认带有一个 minecraft 插件，可将 Minecraft 服务器接入群聊。如果不需要也可以移除：

./micq plugin remove minecraft

更完整的安装、初始化、配置说明见快速开始。

常用命令

./micq init
./micq run
./micq update
./micq plugin list
./micq plugin add <module>[@version]
./micq plugin remove <name-or-module>
./micq plugin update [name-or-module]
./micq version

文档

• 快速开始
• 配置
• Minecraft 插件
• 插件开发
• 消息段
• OneBot Actions
• 内部结构
• 路线图
• 更新日志

开发

如果你要开发 MICQ 或插件，可以先运行：

go vet ./...
go test -race ./...
go build ./src/micq/cmd/micq

许可证

MIT