From d87bd6c3b275b32367b9e60d0f415a4568199f9d Mon Sep 17 00:00:00 2001 From: snowy Date: Sun, 24 Mar 2024 20:40:09 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=AD=97=E4=BD=93?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 68 ++++++++++++++++++++----------------------------------- 1 file changed, 24 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 9a37a584..67155b8f 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ - 全新可视化`npm`包管理，支持一键安装插件 - 支持一切Onebot标准通信 -## 1.手动安装和部署 +## 1.安装和部署 1. 安装`Git`和`Python3.10+` 2. 克隆项目`git clone https://github.com/snowykami/LiteyukiBot` @@ -27,34 +27,10 @@ 4. 安装依赖`pip install -r requirements.txt`(如果多个Python环境请指定后安装`pythonx -m pip install -r requirements.txt`) 5. 启动`python main.py` -## 1.一键部署脚本 -#### 提前部署好`Python3.10+`环境和`Git`环境 - -#### Windows - -```bash -chcp 65001 -git clone https://github.com/snowykami/LiteyukiBot -cd LiteyukiBot -pip install -r requirements.txt -echo python3 main.py > start.bat -echo Install finished! Please click "start.bat" to start the bot! -``` - -#### Linux - -```bash -git clone https://github.com/snowykami/LiteyukiBot -cd LiteyukiBot -pip install -r requirements.txt -echo python3.10 main.py > start.sh -chmod +x start.sh -echo Install finished! Please run "sh start.sh" to start the bot! -``` - -## 2. 配置项(Nonebot插件配置项也可以写在此) +## 2. 配置 +### 轻雪配置项(Nonebot插件配置项也可以写在此) ```yaml # 建议修改的配置项目 command_start: [ "/", " " ] # 指令前缀 @@ -73,39 +49,43 @@ custom_config_1: "custom_value1" ... ``` -## 注意事项 - -- 首次启动会提醒用户注册超级用户 - -- Bot会自动检测新版本，若出现新版本，可用`git pull`命令更新 - ### Onebot实现端配置 +不同的实现端给出的字段可能不同，但是基本上都是一样的，这里给出一个参考值 -| 字段 | 参考值 | 说明 | -|----|-------------------------------|---------------------------| -| 协议 | 反向WebSocket | 轻雪默认使用反向ws协议进行通信，即轻雪作为服务端 | -| 地址 | ws://`host`:`port`/onebot/v11 | 地址取决于配置文件，默认为`20216`端口 | +| 字段 | 参考值 | 说明 | +|-------------|--------------------------|----------------------------------| +| 协议 | 反向WebSocket | 轻雪默认使用反向ws协议进行通信，即轻雪作为服务端 | +| 地址 | ws://`addrss`/onebot/v11 | 地址取决于配置文件，本机默认为`127.0.0.1:20216` | +| AccessToken | `""` | 如果你给轻雪配置了`AccessToken`，请在此填写相同的值 | -### 推荐方案(QQ) +#### 推荐方案(QQ) -1. 使用`Lagrange.OneBot`，点按交互目前仅支持`Lagrange.OneBot`，详细请看[Lagrange.OneBot]() +1. 使用`Lagrange.OneBot`，点按交互目前仅支持`Lagrange.OneBot`，详细请看[Lagrange.OneBot](https://github.com/KonataDev/Lagrange.Core) 2. 云崽的`icqq-plugin`和`ws-plugin`进行通信 3. `Go-cqhttp`（目前已经半死不活了） 4. 人工实现的`Onebot`协议，自己整一个WebSocket客户端，看着QQ的消息，然后给轻雪传输数据 -### 推荐方案(Minecraft) +#### 推荐方案(Minecraft) 1. 我们有专门为Minecraft开发的服务器Bot，支持OnebotV11/12标准，详细请看[MinecraftOneBot](https://github.com/snowykami/MinecraftOnebot) 请先自行查阅文档，若有困难请联系相关开发者而不是Liteyuki的开发者 -## 其他 +## 3.其他 +### 常见问题 +- 设备上Python环境太乱了，pip和python不对应怎么办？ + - 请使用`/path/to/python -m pip install -r requirements.txt`来安装依赖， +然后用`/path/to/python main.py`来启动Bot， +其中`/path/to/python`是你要用来运行Bot可执行文件 +- 为什么我启动后机器人没有反应？ + - 请检查配置文件的`command_start`，并按照正确的命令发送 +### 注意事项 +- 非本项目的问题以及部署方式请勿在本项目提问，否则将会被直接关闭 -- 有一个用`Nuitka`编译的C语言版本可用 +## 4.用户协议 -## 用户协议 1. 本项目遵循`MIT`协议，你可以自由使用，修改，分发，但是请保留原作者信息 2. 轻雪会收集使用者的设备信息，通过安全的方式传输到轻雪服务器，用于统计运行时的设备信息，帮助我们改进轻雪 3. 本项目不会收集用户的任何隐私信息，但请注意甄别第三方插件的安全性 -## 鸣谢 +## 5.鸣谢