基于 Chiyuki & MaiBot 项目开发的 NoneBot 框架的多功能音游 BOT，主要服务 Maimai DX。
使用此项目前，请您确保您下载的源代码为 Release 上提供的代码。
主分支上的项目有可能正在开发，不能保证主分支的代码在 Clone 后可以正常运行，直接将主分支的版本替换正在运行的版本可能会在重新启动后造成灾难性后果（如报错、闪退等导致 Bot 不能服务），建议您下载使用 Release 的仓库代码。
欢迎您使用 Kiba 并搭建属于您自己的 KibaBot！
Kiba 项目是基于 Mai-Bot 与 Chiyuki 项目融合改造创建的适用于为 Maimai DX（Maimai）/雀魂/Arcaea 玩家服务的多功能 Bot。本代码的部分原始内容您可以参阅 https://github.com/Diving-Fish/mai-bot。
在此感谢 Diving-Fish 的 Mai-Bot / Chiyuki 的开源项目。
接下来，本手册为您提供对Kiba最基础的配置、教程与支持。
请自行前往 https://www.python.org/ 下载 Python 3 版本（> 3.7 & < 3.10）并将其添加到环境变量（在安装过程中勾选 Add Python to system PATH）。对大多数用户来说，您应该下载 Windows installer (64-bit)。
在 Linux 系统上，可能需要其他方法安装 Python 3，请自行查找。
建议您使用 Python 3.9 运行此项目。
请您在 Release 栏下载 Kiba 的稳定版本，选择您想使用的对应版本的Source code即可。
在运行项目之前，您需要进入src/static文件夹，解压以static开头的所有 ZIP 压缩文件到src/static中。在此之后，您需要打开控制台，并切换到该项目所在的目录。
以ZIP压缩的资源文件仅供学习交流使用，请自觉在下载 24 小时内删除资源文件。
在 Windows 10 / Windows Server 2016 以上的系统上，您可以直接在项目的根目录（即 bot.py）文件所在的位置按下 Shift + 右键，点击【在此处打开 PowerShell 窗口】。
如果您使用的是更旧的操作系统（比如 Windows 7），请自行查找关于命令提示符(Command Prompt)，Windows Powershell以及cd命令的教程。
打开控制台后，您可以输入
python --version
控制台应该会打印出 Python 的版本。如果提示找不到 python 命令，请检查环境变量，建议您安装 Python 时勾选 Add Python to system PATH。
之后，输入以下命令自动安装依赖。
pip install -r requirements.txt
依赖项目安装完成后，您应设置目录的Config.py。
Config.py在src/libraries文件夹中。使用编辑工具打开后，在 bot_id 一栏中输入您拟运行 Kiba 项目的 QQ 号码，输入完成之后保存关闭。
注意：除 Config.py 外，除非自主添加/删除功能，您不应编辑其他的 '*.py' 文件。否则可能导致 Bot 无法按预期运行。
以上的操作均完成后，回到项目的主文件夹，打开命令提示符或 Powershell。输入此命令运行：
python bot.py
如果输出类似如下所示的内容，代表运行成功：
......
08-02 11:26:49 [INFO] uvicorn | Application startup complete.
08-02 11:26:49 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:10219 (Press CTRL+C to quit)
如果输出了【ERROR】的红色输出，请您再次检查依赖项是否安装齐。
前往 https://github.com/Mrs4s/go-cqhttp > Releases，下载适合自己操作系统的可执行文件。 go-cqhttp 在初次启动时会询问代理方式，选择反向 websocket 代理即可。
之后用任何文本编辑器打开config.yml文件，设置反向 ws 地址、上报方式：
message:
post-format: array
servers:
- ws-reverse:
universal: ws://127.0.0.1:10219/cqhttp/ws然后设置您的 QQ 号和密码。您也可以不设置密码，选择扫码登陆的方式。
登陆成功后，后台应该会发送一条类似的信息：
08-02 11:50:51 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 114514 Accepted!
至此，您可以和对应的 QQ 号聊天并使用 mai bot 的所有功能了。
我不是 Windows 系统？
请您自行查阅其他系统上的 Python 安装方式。cqhttp提供了其他系统的可执行文件，您也可以自行配置 golang module 环境进行编译。
配置 nonebot 或 cq-http 过程中出错？
请查阅 https://github.com/nonebot/nonebot2 以及 https://github.com/Mrs4s/go-cqhttp 中的文档。
部分消息发不出来？
您的账号被风控了。解决方式：换号或者让这个号保持登陆状态和一定的聊天频率，持续一段时间。
歌曲查询显示的图片，左下角"Generated by KibaBot"是否可以更改？
您可以自主使用PhotoShop等修图软件更改此样式。但请保留"Powered by Killua"字样（详见 License）。
Kiba 主要提供了如下功能：
| 命令 | 功能 |
|---|---|
| help | 查看帮助文档 |
| 今日舞萌 | 查看今天的舞萌运势 |
| XXXmaimaiXXX什么 | 随机一首歌 |
| 随个[dx/标准][绿黄红紫白]<难度> | 随机一首指定条件的乐曲 |
| 随[数量]首[dx/标准][绿黄红紫白]<难度> | 随机指定数量的指定条件的乐曲 注意:数量不得超过4个。 |
| 查歌<乐曲标题的一部分> | 查询符合条件的乐曲 |
| [绿黄红紫白]id<歌曲编号> | 查询乐曲信息或谱面信息 |
| <歌曲别名>是什么歌 | 查询乐曲别名对应的乐曲 |
| 定数查歌 <定数> 定数查歌 <定数下限> <定数上限> |
查询定数对应的乐曲 |
| 分数线 <难度+歌曲id> <分数线> | 展示歌曲的分数线 |
| XrY | 在限定的上、下限随机数，要求X、Y均为正整数，且X必须小于Y。 |
| 今日性癖/jrxp | 你出勤时候的性癖是什么？ |
| 戳一戳 | 戳一戳bot试试吧。 |
| 本群戳一戳情况 | 看一下本群谁那么闲得慌 |
| 今日雀魂/雀魂运势 | 查看今天的雀魂运势 |
| mjxp | 你打麻将的时候性癖是什么？ |
| 低情商<字段1>高情商<字段2> | 输出一张低情商与高情商的图 |
| gocho <字段1> <字段2> | 输出一张gocho的图片 |
| 金龙盘旋 <字段1> <字段2> <字段3> | 输出一张金龙盘旋图 |
| 投骰子[数量] | 投指定数量的骰子 |
| 猜歌 | 开始一轮猜歌 (Preview) 注意:目前猜歌是 Alpha Preview 阶段。 已知问题:无法判断用户发布的答案的对错。 |
| 烟我 | 随机禁言1-600秒。 *注意:需要Bot有管理员权限。 |
| b40 / b50 | 根据查分器数据，展示您的 Best 40 或模拟您的 Best 50。 |
更多的功能，您可以对Bot下达'help'命令。
MIT协议
使用此软件代码运行Bot、修改代码，您须遵守 “MIT 协议”。您可以自由使用本项目的代码用于商业或非商业的用途，但您必须附带 MIT 协议。
设计元素
您可以自由修改、编辑代码中的图片设计元素，但请保留"Powered by Killua"以及与功能相关的作者 ID（若有）。