Skip to content

Commit

Permalink
add Chinese readme doc
Browse files Browse the repository at this point in the history
  • Loading branch information
SnapdragonLee committed Feb 22, 2023
1 parent 649e6b5 commit 54ea18a
Show file tree
Hide file tree
Showing 2 changed files with 147 additions and 10 deletions.
22 changes: 12 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@



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

<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>

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

```
{
// Setting hast running locally (only local)
// Setting host running locally (only local)
"server_host": "127.0.0.1:5555",
// Whether to enable ChatGPT auto-reply function
"autoReply": true,
// Setting keyword to wake up in group chat
// Setting keyword to wake up bot in group chat
"groupChatKey": "-c",
// Using reply mode in group chat
"groupReplyMode": false,
// Setting keyword to wake up in private chat
// Setting keyword to wake up bot in private chat
"privateChatKey": "-c",
// Using reply mode in private chat
"privateReplyMode": true,
Expand Down Expand Up @@ -79,23 +81,23 @@ Using ChatGPT-weBot based on ChatGPT and official WeChat. [中文文档](https:/



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

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

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


- Running `funtool_3.6.0.18-1.0.0013.exe`, and press `Start` .
- Running `funtool_3.6.0.18-1.0.0013.exe` , and press `Start` .

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



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

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

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

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

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

No limitation, No usage counting, and no payment needed.



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





###### Reference

- [AutumnWhj/ChatGPT-wechat-bot: ChatGPT for wechat](https://github.com/AutumnWhj/ChatGPT-wechat-bot)
Expand Down
135 changes: 135 additions & 0 deletions Readme_ZH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<h1 align="center">ChatGPT-weBot</h1>



使用基于 ChatGPT (非API-KEY调用) 和 官方微信 hook 接口 的 ChatGPT-weBot 机器人。中文文档 | [English](./Readme.md)

<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>

###### 作者

[Snapdragon Lee (github.com)](https://github.com/SnapdragonLee)

*封面来自 [DALL·E2 (openai.com)](https://labs.openai.com/)*



## 支持和特点

- [x] 支持对话。
- [x] 支持上下文感知问答
- [x] **使用官方微信软件执行,信息来源方面永不封禁。**
- [x] 设置关键字在私聊中唤醒微信机器人
- [x] 设置关键字在群中唤醒微信机器人。(有Bug)
- [x] 在群聊中提到您的机器人时,支持回复消息。(有Bug)
- [ ] 在线获取帮助文档。(待完善)
- [ ] 可以设置关键字以重置之前的对话。(待完善)
- [ ] 重新生成以获得另一个答案。(待完善)
- [ ] 回滚对话。(待完善)
- [ ] 其他





## 默认配置

```
{
// 本地host运行地址(仅本地)
"server_host": "127.0.0.1:5555",
// 是否开启ChatGPT自动回复
"autoReply": true,
// 在群聊中设置唤醒机器人关键词
"groupChatKey": "-c",
// 在群聊中响应回复
"groupReplyMode": false,
// 在私聊中设置唤醒机器人关键词
"privateChatKey": "-c",
// 在私聊中响应回复
"privateReplyMode": true,
// 查看可用命令帮助
"helpKey": "-h",
// 设置重置上下文关键词
"resetChatKey": "-rs",
// 设置重新生成答案关键词
"regenerateKey": "-rg",
// 设置回滚到以前的n个问题关键词
"rollbackKey": "-rb"
}
```





## 启动步骤

1. 安装 `requirements.txt` 中列出的所有包,使用如下命令:

```
pip install -r ./requirements.txt
```



2. 从 Github Releases 下载需要的包。

3. 在您的计算机上安装 `WeChat-3.6.0.18.exe`**如果您正在使用的微信版本高于3.6.0.18,可以降级覆盖安装。** 之后请登陆您的微信。



4. 运行服务器监控微信消息。这里有两种方法可以实现,请 ***二选一***

- 打开名字为 `DLLinjector_V1.0.3.exe` 的注入器,然后选择文件名为 `3.6.0.18-0.0.0.008.dll` 并注入。

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


- 运行 `funtool_3.6.0.18-1.0.0013.exe` ,后点击 `Start`

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

5.`.config/` 目录下填写 JSON 文件。

-`config.json` 中,您需要根据自己的偏好配置自定义选项。

-`rev_config.json` 中,您需要通过*选择下面其中一种方法* 来填写 ChatGPT 登录信息:

- 电子邮件/密码 **(不支持 Google/Microsoft 帐户)**

- session_token **(支持 Google/Microsoft 帐户)**

> 1. 进入 [`chat.openai.com/chat`](https://chat.openai.com/chat) 并登录或注册。
> 2.`F12` 打开开发工具。
> 3. 将 cookie 中的 `__Secure-next-auth.session-token` 项复制。
6. 运行以下命令启动服务:

```
python main.py
```

**一切准备就绪,欢迎使用 ChatGPT-weBot!**

没有限制、没有使用计数,也没有付费要求。





## 常见问题解答

1. 如何获取所有的回复?您可以用您的语言说 “请继续”。
2. 遇到问题了吗?随时来创建一个 issue 进行发布。



###### 参考

- [AutumnWhj/ChatGPT-wechat-bot: ChatGPT for wechat](https://github.com/AutumnWhj/ChatGPT-wechat-bot)
- [cixingguangming55555/wechat-bot: 带二次开发接口的PC微信聊天机器人](https://github.com/cixingguangming55555/wechat-bot)

0 comments on commit 54ea18a

Please sign in to comment.