Skip to content

Quick Start

MarkChai edited this page Jul 16, 2026 · 1 revision

快速开始

本指南将帮助你五分钟内使用 yes-core 跑起一个 QQ 机器人。

1. 环境准备

  • Go 1.20+
  • 一个运行好的 OneBot v11 协议端(如 NapCatQQ / Lagrange)

2. 初始化项目

创建一个新的 Go 项目,并引入必要的包:

mkdir my-bot && cd my-bot
go mod init my-bot
go get github.com/yeswearebot/yes-core
go get github.com/yeswearebot/plugin_config
go get github.com/yeswearebot/adapter-manager
go get github.com/yeswearebot/adapter-onebot

3. 编写主程序 (main.go)

像搭积木一样匿名引入需要的插件包,框架会自动完成实例化和启动:

package main

import (
    "github.com/yeswearebot/yes-core/core"

    _ "github.com/yeswearebot/plugin_config"
    _ "github.com/yeswearebot/adapter-onebot"
    _ "github.com/yeswearebot/adapter-manager"
    _ "my-bot/my-plugin" // 你的业务插件
)

func main() {
    app := core.NewApp()
    if err := app.Run(); err != nil {
        panic(err)
    }
}


## 4. 编写配置文件 (config.yaml)

在项目根目录创建 `config.yaml`配置 OneBot 连接信息```yaml
onebot:
    host: “127.0.0.1:3000” # 你的 OneBot WebSocket 地址
    path: “/ws”
    token: “” # 鉴权 Token

5. 运行!

go run main.go

如果看到 [AdapterManager] 初始化完成 和适配器连接成功的日志,说明你的机器人已经跑起来了!接下来请阅读 业务插件开发 来编写你的功能。

Clone this wiki locally