# KiviBot

## 使用

### 创建新项目

```bash
# 通过 KiviBot CLI 创建新项目
npx kivibot new --name bot

# ... 接下来按照提示配置 `kivi.config.toml`

# 创建完后，切换到项目目录、安装依赖并启动
cd bot && npm i && npm run start
```

### 创建新插件

> `kivibot` 会注册 `kivi` 命令，`npm i` 之后，CLI 可以直接通过 `npx kivi` 使用

```bash
npx kivi plugin add --name new-plugin
```

### 消息指令

通过 `#帮助` 查看所有消息指令，通过 `#插件` 查看插件子指令，通过 `#设置` 查看设置子指令。

## 配置文件说明

```toml
# 机器人的 QQ 号
uin = 1145141919
# 机器人的 QQ 密码，为空则使用扫码
password = ""
# 机器人的主人，拥有框架层的最高权限，可以执行所有命令
owners = [1919114514]
# 机器人的管理员，原则上只有插件层管理权限，不能执行框架层的命令
admins = []
# 机器人的插件，插件的加载顺序按照列表的顺序
plugins = ["echo"]

# 传给 oicq/icqq 的 createClient 方法的参数
[oicq]
# 日志级别，可选值：trace, debug, info, warn, error
log_level = "trace"
# 登录协议，1 为安卓手机, 2 为安卓平板, 3 为安卓手表, 4 为 MacOS, 5 为 iPad
platform = 2
# 使用的协议版本，不指定或为空时使用最新版本
# ver = ""
# 签名 API 地址，不指定使用内置默认签名
sign_api_addr = ""
```