diff --git a/README.md b/README.md index 856d864..add505c 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,21 @@ A QQbot Based on Nonebot. > This bot will use MySQL to storge your & others Userid & Token. > Make sure your have a MySQL database on your device. > You can change IP(/nonebot_plugin_maimai_helper/util/utils.py) if your database isn't on your local device. + +-------- + +# 如何使用SaltBot +> [!CAUTION] +> 这篇指南默认你拥有基础计算机知识。 +> 此 Bot 将需要更改一些代码以正确运行。 + +1. 安装 [Python3.12](https://www.python.org/downloads/release/python-3129/) +2. 安装 [Nonebot](https://nonebot.dev/docs/quick-start) +3. 下载此仓库到你的本地设备。 +4. 更改在/.venv/Lib/site-packages/nonebot_plugin_maimai_helper/__init__.py下的第 87, 93, 201, 204, 205行的脚本路径。(不要在意我的狗史代码,谢谢你¯\_(ツ)_/¯) +5. 在Bot运行目录下运行 `nb run` 指令以启动。 + +> [!NOTE] +> 此Bot依赖于MySQL数据库以存储你和别人的*userid*和*token*。 +> 请确保你在本地部署并启动了一个MySQL数据库。 +> 如果你的数据库不在本地部署,你可以在(/nonebot_plugin_maimai_helper/util/utils.py)更改数据库IP。