Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gylove1994/mitsuki-bot

基于mirai及mirai-ts构建的qq消息机器人
https://github.com/gylove1994/mitsuki-bot

Last synced: 8 days ago
JSON representation

基于mirai及mirai-ts构建的qq消息机器人

Awesome Lists containing this project

README

        

# Mitsuki-bot v0.1.0说明文档

## 介绍

psc

Mitsuki-bot是基于[mirai](https://github.com/mamoe/mirai)及[mirai-ts](https://github.com/YunYouJun/mirai-ts)构建的qq消息机器人,其名字取自《巧克甜恋2》中的百々瀬 みつき(Momose Mitsuki)。该项目其主要目的是构建了一个具有清晰结构的qq机器人,但由于个人经验较少,所以该项目应该只是您构建属于您自己项目的参考(如果想直接用也是没问题的啦),同时在该项目中会包含一系列的小实例以帮助您可以更快的了解和上手mirai-ts,最后如果有帮助的话请记得给我一个star,也欢迎各位帮助和改进Mitsuki-bot项目0.0

## 开源许可证

由于[mirai](https://github.com/mamoe/mirai)及[mirai-ts](https://github.com/YunYouJun/mirai-ts)所使用的许可证为**AGPL-3.0 License**,故本项目也使用[AGPL-3.0 License](https://github.com/gylove1994/mitsuki-bot/blob/master/LICENSE)开源许可证,请遵守相关的规范。

## 处理流程

mmcm

受mvc的启发,个人认为QQ机器人对于消息应答的一个完整的处理流程如下:

- 首先,所收到的原始消息经过一个或者数个中间件处理后,根据处理的结果传入到对应的控制器中;
- 其次,由对应的控制器处理对应的事件。其中若需要有关数据库操作及调用其他api时,请将这部分内容交由对应的业务模型完成。
- 最后,由控制器的处理结果表明是否需要对消息进行回复,若需要则由控制器组织回复内容并发出,若不需要则结束这次的事件处理。

## 目录结构

```text
.
├── dist //编译后文件所存放的文件夹
│ └── ....
├── node_modules //node_modules包文件夹
│ └── ....
├── src //源码文件夹
│ ├── config //用于存放一些设置的文件夹(由于有隐私内容不公开)
│ │ └── ....
│ ├── config_example //用于存放一些设置示例的文件夹
│ │ └── ....
│ ├── controller //用于存放控制器的文件夹
│ │ └── ....
│ ├── middleware //用于存放中间件的文件夹
│ │ └── ....
│ ├── model //用于存放业务模型的文件夹
│ │ └── ....
│ ├── types //用于存放自定义类型的文件夹
│ │ └── ....
│ └── app.ts //程序主入口
├── tutorial //有关mirai-ts的小实例
│ └── ....
├── .gitignore //git忽略设置
├── LICENSE //AGPLv3开源许可证
├── mitsuki.db //sqlite数据库文件
├── nodemon.json //nodemon设置,用于项目的检测代码改变并重启服务
├── package.json //项目相关信息
├── tsconfig.json //ts设置
├── readMe.md //项目介绍
└── yarn.lock //yarn包管理器自动生成
```