Update usage
This commit is contained in:
52
README.MD
52
README.MD
@@ -1,9 +1,13 @@
|
|||||||
# WeChatRobot
|
# WeChatRobot
|
||||||
一个基于 [WeChatFerry](https://github.com/lich0821/WeChatFerry) 的微信机器人示例。
|
一个基于 [WeChatFerry](https://github.com/lich0821/WeChatFerry) 的微信机器人示例。
|
||||||
|
|
||||||
|
👉 [视频教程](https://mp.weixin.qq.com/s/omuSBeZRKSjo0PEtjwey7A)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
0. 安装 Python,例如 [3.7.9](https://www.python.org/ftp/python/3.7.9/python-3.7.9.exe)
|
0. 安装 Python,例如 [3.7.9](https://www.python.org/ftp/python/3.7.9/python-3.7.9.exe)
|
||||||
1. 安装微信 `3.7.0.30`,下载地址在[这里](https://github.com/lich0821/WeChatFerry/releases/download/v3.7.0.30.15/WeChatSetup-3.7.0.30.exe);也可以从 [WeChatSetup](https://gitee.com/lch0821/WeChatSetup) 找到。
|
1. 安装微信 `3.7.0.30`,下载地址在 [这里](https://github.com/lich0821/WeChatFerry/releases/download/v3.7.0.30.21/WeChatSetup-3.7.0.30.exe);也可以从 [WeChatSetup](https://gitee.com/lch0821/WeChatSetup) 找到。
|
||||||
2. 安装依赖
|
2. 安装依赖
|
||||||
```sh
|
```sh
|
||||||
# 升级 pip
|
# 升级 pip
|
||||||
@@ -12,32 +16,40 @@ python -m pip install -U pip
|
|||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
3. 按需修改配置
|
3. 运行
|
||||||
|
|
||||||
从配置模板 `config.yaml.template` 复制一份配置文件 `config.yaml`,按需修改其中的配置。
|
没必要先打开微信,直接运行程序会自动拉起微信:
|
||||||
|
|
||||||
* 为了响应群聊消息,需要添加相应的 `roomId`:
|
|
||||||
```yaml
|
|
||||||
groups:
|
|
||||||
enable: [] # 允许响应的群 roomId,可以通过 WxGetContacts 获取
|
|
||||||
```
|
|
||||||
|
|
||||||
* 为了使用ChatGPT,需要配置OpenAI的Key
|
|
||||||
```yaml
|
|
||||||
chatgpt:
|
|
||||||
key: xxxxxxxxxxxxxxxxxxxxx # 你的 OpenAI Key
|
|
||||||
```
|
|
||||||
|
|
||||||
4. 运行
|
|
||||||
```sh
|
```sh
|
||||||
python main.py
|
python main.py
|
||||||
# 如果微信未打开,会自动打开微信;如果版本不对,也会有提示;其他报错,请进群交流。
|
# 如果微信未打开,会自动打开微信;如果版本不对,也会有提示;其他报错,请进群交流。
|
||||||
```
|
```
|
||||||
|
|
||||||

|
### 修改配置
|
||||||
|
配置文件 `config.yaml` 是运行程序后自动从模板复制过来的,以下功能默认关闭。
|
||||||
|
|
||||||
👉 [视频教程](https://mp.weixin.qq.com/s/omuSBeZRKSjo0PEtjwey7A)
|
* 为了响应群聊消息,需要添加相应的 `roomId`(打印的消息中方括号里的就是):
|
||||||
|
```yaml
|
||||||
|
groups:
|
||||||
|
enable: [] # 允许响应的群 roomId,大概长这样:2xxxxxxxxx3@chatroom
|
||||||
|
```
|
||||||
|
|
||||||
欢迎加群交流,后台回复 `WeChatFerry `:
|
* 为了使用 ChatGPT,需要取消配置中 chatgpt 的注释, 并配置 OpenAI 的 Key(以及代理):
|
||||||
|
```yaml
|
||||||
|
# 如果要使用 ChatGPT,取消下面的注释并填写相关内容
|
||||||
|
chatgpt:
|
||||||
|
key: 填写你 ChatGPT 的 key
|
||||||
|
api: https://api.openai.com/v1 # 如果你不知道这是干嘛的,就不要改
|
||||||
|
proxy: # 如果你在国内,你可能需要魔法,大概长这样:http://域名或者IP地址:端口号
|
||||||
|
```
|
||||||
|
|
||||||
|
* 为了暴露 HTTP 接口,需要取消配置中 http 的注释:
|
||||||
|
```yaml
|
||||||
|
# 如果需要暴露 HTTP 接口,取消下面的注释
|
||||||
|
http:
|
||||||
|
host: 0.0.0.0
|
||||||
|
port: 9999
|
||||||
|
```
|
||||||
|
|
||||||
|
欢迎加群交流,后台回复 **`WeChatFerry`**(*注意大小写*):
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
Reference in New Issue
Block a user