Skip to content

Commit

Permalink
docs: add ZH doc
Browse files Browse the repository at this point in the history
  • Loading branch information
iuiaoin committed Jun 6, 2023
1 parent 2387944 commit ec4f870
Showing 1 changed file with 114 additions and 0 deletions.
114 changes: 114 additions & 0 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
<h1 align="center">欢迎使用 wechat-gptbot 👋</h1>
<div align="center">
<img width="200" src="./docs/images/logo.png">
</div>
<p>
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
<a href="#" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-green.svg" />
</a>
<a href="https://www.python.org/">
<img
alt="Python Version"
src="https://img.shields.io/badge/python-%20%3E%3D%203.8-brightgreen"
/>
</a>
</p>

> 基于 ChatGPT 的微信机器人,无风险且非常稳定! 🚀
> [English](README.md) | 中文文档
## 🎤 简介

> 我在使用基于 `itchat``wechaty` 的聊天机器人时,经常会遇到扫码登录账号被限制的风险。参考 [#158](https://github.com/AutumnWhj/ChatGPT-wechat-bot/issues/158). 有没有安全的方法来使用微信机器人呢? 在这里~
## 🌟 特性

- [x] **非常稳定:** 基于 windows hook 实现,不用担心微信账号被限制的风险
- [x] **基础对话:** 私聊及群聊的消息智能回复,支持多轮会话上下文记忆,支持 GPT-3,GPT-3.5,GPT-4 模型
- [x] **图片生成:** 支持图片生成, 目前暂时只支持 Dell-E 模型
- [x] **灵活配置:** 支持 prompt 设置, proxy, 命令设置等.

## 🚀 快速开始

### 环境

支持 Windows 系统(以后可能会基于 [sandbox](https://github.com/huan/docker-wechat) 支持 Linux) 同时需要安装 `Python`

> 建议 Python 版本在 3.8.X~3.10.X 之间, 推荐 3.8 版本
#### 1. 克隆项目

```bash
git clone https://github.com/iuiaoin/wechat-gptbot && cd wechat-gptbot
```

#### 2. 安装依赖

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

### 配置

配置文件的模板在根目录的 `config.template.json` 中,需复制该模板创建最终生效的 `config.json` 文件

```bash
cp config.template.json config.json
```

`config.json` 中填入配置,以下是对默认配置的说明,可根据需要进行自定义修改:

```bash
{
"openai_api_key": "YOUR API SECRET KEY", # 填入你的 OpenAI API Key
"model": "gpt-3.5-turbo", # 要使用的模型 ID, 支持 gpt-3.5-turbo, gpt-4, gpt-4-32k 等
"role_desc": "You are a helpful assistant.", # 角色描述, 作为系统 prompt
"session_expired_duration": 3600, # 对话记忆的保留时长
"max_tokens": 1000, # 对话记忆字符的最大 token 数量
"temperature": 0.9, # 在 0 到 2 之间. 更高的数值会使 chatGPT 的输出更加随机, 而较低的数值会使其更加稳定
"proxy": "127.0.0.1:3000", # 代理客户端的ip和端口
"create_image_prefix": ["draw", "paint", "imagine"], # 开启图片回复的前缀
"clear_current_session_command": "#clear session", # 清楚当前对话记忆
"clear_all_sessions_command": "#clear all sessions" # 清楚所有对话记忆
}
```

### 运行

#### 1. 准备

> 我们需要特定的微信版本和 dll 来使 windows hook 正常生效。
1.[release](https://github.com/iuiaoin/wechat-gptbot/releases/tag/v1.0.0) 中下载相关文件
2. 安装 WeChatSetup 3.2.1.121 版本并且登录
3. 运行微信 dll 注入器
4. 选择 3.2.1.121-LTS.dll 并且 点击 `注入dll`, 如果成功的话你将会看到: "成功注入: 3.2.1.121-LTS.dll"

#### 2. 运行命令

```bash
python app.py
```

<img width="1440" src="./docs/images/shell.png">

噹噹! 享受你的探索之旅吧~

## ✨ 贡献者

<a href="https://github.com/iuiaoin/wechat-gptbot/graphs/contributors">
<img src="https://contrib.rocks/image?repo=iuiaoin/wechat-gptbot" />
</a>

## 🤝 为项目添砖加瓦

欢迎提出 Contributions, issues 与 feature requests!<br />随时查看 [issues page](https://github.com/iuiaoin/wechat-gptbot/issues).

## 🙏 感性支持

如果你喜欢这个项目的话,请为它点上一颗 ⭐️

## 📢 声明

WeChatSetup 安装包来自于 [wechat-windows-versions](https://github.com/tom-snow/wechat-windows-versions), 微信 dll 注入器来自于 [wechat-bot](https://github.com/cixingguangming55555/wechat-bot), 所以你可以放心使用它。还要感谢两个 repo 的所有者的贡献。

0 comments on commit ec4f870

Please sign in to comment.