# CoolQBot

**Repository Path**: he0119/CoolQBot

## Basic Information

- **Project Name**: CoolQBot
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-04-23
- **Last Updated**: 2023-08-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!-- markdownlint-disable-next-line MD033 MD041 -->
<div align="center">

# CoolQBot

![CI](https://github.com/he0119/CoolQBot/workflows/CI/badge.svg)
[![codecov](https://codecov.io/gh/he0119/CoolQBot/branch/master/graph/badge.svg?token=QEC2IWAREH)](https://codecov.io/gh/he0119/CoolQBot)
[![Powered by NoneBot](https://img.shields.io/badge/Powered%20%20by-NoneBot-red)](https://github.com/nonebot/nonebot2)

</div>

这只是一个随便写写的机器人，主要工作就是按照一定的规则进行复读 ~~（模仿人类）~~，其他功能都是增加可玩性的。

关于名称：最早机器人是基于 `酷Q`，然而现在已经是时代的眼泪。想想还是把这个名字保留下来，留作纪念。

## 运行

<!-- markdownlint-disable-next-line MD013 -->

请先参考 [文档](https://v2.nonebot.dev/guide/getting-started.html#%E9%85%8D%E7%BD%AE-qq-%E5%8D%8F%E8%AE%AE%E7%AB%AF) 配置好 `go-cqhttp`。

接下来就可以尝试第一次运行机器人。

```shell
# 首先克隆代码到本地
git clone https://github.com/he0119/CoolQBot.git
# 配置机器人通用配置
vim .env
# 安装机器人所需依赖
poetry install
# 运行机器人
nb run
```

第一次运行之后会在 `nb datastore dir` 命令输出的文件夹下创建文件夹并生成各个插件的默认配置。

请按需进行调整之后重新运行机器人便可使用。

### Docker

如果你的计算机上安装有 [Docker](https://www.docker.com/get-started)。

你不需要执行上面的步骤，请直接将仓库中的 `docker-compose.yml` 和 `.env` 文件放置在一个你想存放机器人的文件夹内。

```shell
# 然后配置 go-cqhttp，请参考上面的文档
# 以下是单独运行 go-cqhttp 的命令
sudo docker run -it --rm -v $PWD/cqhttp:/data ghcr.io/mrs4s/go-cqhttp:latest
```

完成 `go-cqhttp` 配置之后在 `docker-compose.yml` 文件所在目录下运行 `sudo docker compose up -d`，便可启动机器人。

修改完机器人相关配置之后运行 `sudo docker compose restart` 重启机器人应用配置。

推荐使用 `Docker` 部署，因为机器人的音乐插件依赖于 [netease_cloud_music_api](https://github.com/Binaryify/NeteaseCloudMusicApi)。

## 功能

请完成部署之后，向机器人发送 `/help` 命令获取各种功能的介绍。