feat:初版
This commit is contained in:
104
README.md
Normal file
104
README.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# WechatHookBot
|
||||
|
||||
基于个微大客户版 Hook API 的微信机器人框架,参考 XYBotV2 架构设计。
|
||||
|
||||
## 项目特点
|
||||
|
||||
- 🎯 **无需登录**:Hook 已登录的微信客户端,无需二维码登录
|
||||
- 🔌 **插件化**:完全兼容 XYBotV2 插件系统
|
||||
- ⚡ **实时回调**:Socket 回调机制,消息接收更及时
|
||||
- 🚀 **轻量级**:无需 Redis,架构更简单
|
||||
|
||||
## 技术栈
|
||||
|
||||
- Python 3.x (32位)
|
||||
- asyncio 异步编程
|
||||
- ctypes DLL 调用
|
||||
- SQLite 数据库
|
||||
- APScheduler 定时任务
|
||||
- Flask + SocketIO (WebUI)
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
|
||||
- Windows 系统
|
||||
- Python 3.x (32位版本)
|
||||
- 微信客户端已登录
|
||||
|
||||
### 安装
|
||||
|
||||
```bash
|
||||
cd WechatHookBot
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### 配置
|
||||
|
||||
编辑 `main_config.toml` 配置文件:
|
||||
|
||||
```toml
|
||||
[WechatHook]
|
||||
loader-dll = "libs/Loader.dll"
|
||||
helper-dll = "libs/Helper.dll"
|
||||
|
||||
[Bot]
|
||||
admins = ["your_wxid"]
|
||||
disabled-plugins = []
|
||||
```
|
||||
|
||||
### 运行
|
||||
|
||||
```bash
|
||||
# 简单启动(无 WebUI)
|
||||
python bot.py
|
||||
|
||||
# 完整启动(带 WebUI)
|
||||
python app.py
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
WechatHookBot/
|
||||
├── docs/ # 文档目录
|
||||
│ ├── 架构设计.md
|
||||
│ ├── 插件开发.md
|
||||
│ └── API文档.md
|
||||
├── WechatHook/ # Hook 层
|
||||
├── utils/ # 工具类
|
||||
├── database/ # 数据库
|
||||
├── plugins/ # 插件目录
|
||||
├── WebUI/ # Web 管理界面
|
||||
├── libs/ # DLL 文件
|
||||
├── bot.py # 主入口
|
||||
├── app.py # WebUI 入口
|
||||
└── main_config.toml # 主配置
|
||||
```
|
||||
|
||||
## 文档
|
||||
|
||||
- [架构设计](docs/架构设计.md) - 技术架构和设计思路
|
||||
- [插件开发](docs/插件开发.md) - 插件开发指南
|
||||
- [API 文档](docs/API文档.md) - WechatHook API 说明
|
||||
|
||||
## 注意事项
|
||||
|
||||
⚠️ **重要提示**
|
||||
|
||||
- 必须使用 32位 Python
|
||||
- 需要微信客户端在运行
|
||||
- DLL 可能被杀毒软件拦截,需添加信任
|
||||
- Hook 方式风控风险较高,谨慎使用
|
||||
|
||||
## 免责声明
|
||||
|
||||
本项目仅供学习和技术研究使用,不得用于任何商业或非法行为。使用本工具造成的任何后果由使用者自行承担。
|
||||
|
||||
## 开发状态
|
||||
|
||||
🚧 项目开发中...
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
Reference in New Issue
Block a user