Skip to content

Commit 54ea18a

Browse files
committed
add Chinese readme doc
1 parent 649e6b5 commit 54ea18a

File tree

2 files changed

+147
-10
lines changed

2 files changed

+147
-10
lines changed

Readme.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44

5-
Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https://github.com/SnapdragonLee/ChatGPT-weBot/Readme_ZH.md) | English
5+
Using ChatGPT-weBot based on ChatGPT(Non-API key call) and official WeChat hook interface. [中文文档](./Readme_ZH.md) | English
66

77
<div align="center"> <img src="assets/DALL·E - A robot is working hard to transform, modify, and revolutionize the WeChat software.png" width="50%"> </div>
88

@@ -19,6 +19,7 @@ Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https:/
1919
- [x] Support conversation.
2020
- [x] Support context-aware question answering
2121
- [x] **Never get banned by using official WeChat execution.**
22+
- [x] Set the keywords to wake up the WeChat robot in private.
2223
- [x] Set the keywords to wake up the WeChat robot in the group. **(have bugs)**
2324
- [x] Support replying message when mentioning your bot in the group. **(have bugs)**
2425
- [ ] Get help doc in line. **(need work)**
@@ -35,15 +36,16 @@ Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https:/
3536

3637
```
3738
{
38-
// Setting hast running locally (only local)
39+
// Setting host running locally (only local)
3940
"server_host": "127.0.0.1:5555",
4041
42+
// Whether to enable ChatGPT auto-reply function
4143
"autoReply": true,
42-
// Setting keyword to wake up in group chat
44+
// Setting keyword to wake up bot in group chat
4345
"groupChatKey": "-c",
4446
// Using reply mode in group chat
4547
"groupReplyMode": false,
46-
// Setting keyword to wake up in private chat
48+
// Setting keyword to wake up bot in private chat
4749
"privateChatKey": "-c",
4850
// Using reply mode in private chat
4951
"privateReplyMode": true,
@@ -79,23 +81,23 @@ Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https:/
7981

8082

8183

82-
4. Monitoring WeChat message by running a server. There is 2 way to get this:
84+
4. Monitoring WeChat message by running a server. Here are two methods to achieve this, **please *choose 1 method*** :
8385

8486
- Using injector named `DLLinjector_V1.0.3.exe`, then choose file named `3.6.0.18-0.0.0.008.dll` to inject.
8587

8688
![image-20230221044543472](assets/image-20230221044543472.png)
8789

8890
8991

90-
- Running `funtool_3.6.0.18-1.0.0013.exe`, and press `Start` .
92+
- Running `funtool_3.6.0.18-1.0.0013.exe` , and press `Start` .
9193

9294
![image-20230221044609319](assets/image-20230221044609319.png)
9395

9496

9597

9698
5. The last step is fill json files listed in `.config/` .
9799

98-
- In `config.json` , you can configure your custom options based on your preferences.
100+
- In `config.json` , you need to configure your custom options based on your preferences.
99101

100102
- In `rev_config.json` , you need to fill your ChatGPT login information by *choosing 1 method*:
101103

@@ -115,7 +117,9 @@ Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https:/
115117
python main.py
116118
```
117119

118-
**Everything is ready, feel free to go online with your ChatGPT-weBot** ! No limitation, No usage counting, and no payment needed.
120+
**Everything is ready, feel free to go online with your ChatGPT-weBot !**
121+
122+
No limitation, No usage counting, and no payment needed.
119123

120124

121125

@@ -128,8 +132,6 @@ Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https:/
128132

129133

130134

131-
132-
133135
###### Reference
134136

135137
- [AutumnWhj/ChatGPT-wechat-bot: ChatGPT for wechat](https://github.com/AutumnWhj/ChatGPT-wechat-bot)

Readme_ZH.md

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
<h1 align="center">ChatGPT-weBot</h1>
2+
3+
4+
5+
使用基于 ChatGPT (非API-KEY调用) 和 官方微信 hook 接口 的 ChatGPT-weBot 机器人。中文文档 | [English](./Readme.md)
6+
7+
<div align="center"> <img src="assets/DALL·E - A robot is working hard to transform, modify, and revolutionize the WeChat software.png" width="50%"> </div>
8+
9+
###### 作者
10+
11+
[Snapdragon Lee (github.com)](https://github.com/SnapdragonLee)
12+
13+
*封面来自 [DALL·E2 (openai.com)](https://labs.openai.com/)*
14+
15+
16+
17+
## 支持和特点
18+
19+
- [x] 支持对话。
20+
- [x] 支持上下文感知问答
21+
- [x] **使用官方微信软件执行,信息来源方面永不封禁。**
22+
- [x] 设置关键字在私聊中唤醒微信机器人
23+
- [x] 设置关键字在群中唤醒微信机器人。(有Bug)
24+
- [x] 在群聊中提到您的机器人时,支持回复消息。(有Bug)
25+
- [ ] 在线获取帮助文档。(待完善)
26+
- [ ] 可以设置关键字以重置之前的对话。(待完善)
27+
- [ ] 重新生成以获得另一个答案。(待完善)
28+
- [ ] 回滚对话。(待完善)
29+
- [ ] 其他
30+
31+
32+
33+
34+
35+
## 默认配置
36+
37+
```
38+
{
39+
// 本地host运行地址(仅本地)
40+
"server_host": "127.0.0.1:5555",
41+
42+
// 是否开启ChatGPT自动回复
43+
"autoReply": true,
44+
// 在群聊中设置唤醒机器人关键词
45+
"groupChatKey": "-c",
46+
// 在群聊中响应回复
47+
"groupReplyMode": false,
48+
// 在私聊中设置唤醒机器人关键词
49+
"privateChatKey": "-c",
50+
// 在私聊中响应回复
51+
"privateReplyMode": true,
52+
53+
// 查看可用命令帮助
54+
"helpKey": "-h",
55+
// 设置重置上下文关键词
56+
"resetChatKey": "-rs",
57+
// 设置重新生成答案关键词
58+
"regenerateKey": "-rg",
59+
// 设置回滚到以前的n个问题关键词
60+
"rollbackKey": "-rb"
61+
}
62+
```
63+
64+
65+
66+
67+
68+
## 启动步骤
69+
70+
1. 安装 `requirements.txt` 中列出的所有包,使用如下命令:
71+
72+
```
73+
pip install -r ./requirements.txt
74+
```
75+
76+
77+
78+
2. 从 Github Releases 下载需要的包。
79+
80+
3. 在您的计算机上安装 `WeChat-3.6.0.18.exe`**如果您正在使用的微信版本高于3.6.0.18,可以降级覆盖安装。** 之后请登陆您的微信。
81+
82+
83+
84+
4. 运行服务器监控微信消息。这里有两种方法可以实现,请 ***二选一***
85+
86+
- 打开名字为 `DLLinjector_V1.0.3.exe` 的注入器,然后选择文件名为 `3.6.0.18-0.0.0.008.dll` 并注入。
87+
88+
![image-20230221044543472](assets/image-20230221044543472.png)
89+
90+
91+
92+
- 运行 `funtool_3.6.0.18-1.0.0013.exe` ,后点击 `Start`
93+
94+
![image-20230221044609319](assets/image-20230221044609319.png)
95+
96+
5.`.config/` 目录下填写 JSON 文件。
97+
98+
-`config.json` 中,您需要根据自己的偏好配置自定义选项。
99+
100+
-`rev_config.json` 中,您需要通过*选择下面其中一种方法* 来填写 ChatGPT 登录信息:
101+
102+
- 电子邮件/密码 **(不支持 Google/Microsoft 帐户)**
103+
104+
- session_token **(支持 Google/Microsoft 帐户)**
105+
106+
> 1. 进入 [`chat.openai.com/chat`](https://chat.openai.com/chat) 并登录或注册。
107+
> 2.`F12` 打开开发工具。
108+
> 3. 将 cookie 中的 `__Secure-next-auth.session-token` 项复制。
109+
110+
6. 运行以下命令启动服务:
111+
112+
```
113+
python main.py
114+
```
115+
116+
**一切准备就绪,欢迎使用 ChatGPT-weBot!**
117+
118+
没有限制、没有使用计数,也没有付费要求。
119+
120+
121+
122+
123+
124+
## 常见问题解答
125+
126+
1. 如何获取所有的回复?您可以用您的语言说 “请继续”。
127+
2. 遇到问题了吗?随时来创建一个 issue 进行发布。
128+
129+
130+
131+
###### 参考
132+
133+
- [AutumnWhj/ChatGPT-wechat-bot: ChatGPT for wechat](https://github.com/AutumnWhj/ChatGPT-wechat-bot)
134+
- [cixingguangming55555/wechat-bot: 带二次开发接口的PC微信聊天机器人](https://github.com/cixingguangming55555/wechat-bot)
135+

0 commit comments

Comments
 (0)