添加readme

This commit is contained in:
wangqiupei
2025-03-10 12:47:16 +08:00
parent a855b035a8
commit 499bf2d5f8

128
README.md Normal file
View File

@@ -0,0 +1,128 @@
# Free V2Ray 节点收集与测试工具
这是一个用Python编写的工具用于自动收集、解析、测试和筛选可用的免费V2Ray节点。该工具支持多种代理协议和格式可以帮助您快速获取可用的代理节点资源。
## 主要功能
- 从多个在线资源自动获取免费节点信息
- 支持多种格式的解析Base64、YAML、JSON、URI等
- 支持多种代理协议VMess、Trojan、VLESS、Shadowsocks、Shadowsocks-R等
- 使用V2Ray/XRay核心程序进行实际连接测试
- 自动测量节点延迟并筛选可用节点
- 去除重复节点
- 以标准格式导出可用节点信息
## 支持的协议
- VMess
- Trojan
- VLESS
- Shadowsocks (SS)
- Shadowsocks-R (SSR)
- HTTP/HTTPS
- SOCKS
- Hysteria
- WireGuard
## 安装依赖
```bash
pip install requests pyyaml
```
如果需要HTML解析功能用于特定网站
```bash
pip install beautifulsoup4
```
## 使用方法
1. 运行主脚本:
```bash
python main.py
```
2. 工具会自动:
- 从预定义的链接获取节点信息
- 解析不同格式的节点配置
- 进行去重处理
- 测试节点的连接质量和延迟
- 生成最终的节点列表
3. 测试完成后,结果会保存到:
- `v2ray.txt`Base64编码的节点信息可直接导入到V2Ray客户端
- `v2ray_raw.txt`:原始文本格式的节点信息(方便查看)
## 代码结构
- `main.py`:主程序入口,包含所有功能实现
- 主要功能模块:
- 订阅链接获取:`fetch_content`
- 节点解析:`extract_nodes``parse_clash_yaml``parse_v2ray_base64``parse_v2ray_uri``parse_json_nodes`
- 节点测试:`test_node_latency``test_latency`
- 节点处理:`process_node``remove_duplicates`
- 核心程序管理:`find_core_program``download_xray_core`
## 订阅链接配置
编辑脚本中的`links`列表可以自定义订阅链接:
```python
links = [
"https://example.com/subscription1",
"https://example.com/subscription2",
# 添加更多链接...
]
```
支持多种链接格式包含日期变量和GitHub仓库链接。
## 特性
### 自动下载核心程序
如果系统中未找到V2Ray或XRay核心程序工具会自动从GitHub下载最新版本。
### 多种格式解析
工具支持按照以下顺序尝试解析节点信息:
1. Base64编码内容
2. YAML/Clash配置
3. 使用正则表达式直接提取
4. JSON格式数据
### 智能链接处理
- 支持日期变量替换(如`{Y}``{m}``{d}``{Ymd}`等)
- 支持GitHub仓库文件自动获取`{x}`占位符)
- 特殊站点的特殊处理逻辑
### 测试方法
使用V2Ray/XRay核心程序建立真实连接通过访问Google测试端点`http://www.gstatic.com/generate_204`)来测量延迟。
## 注意事项
1. 该工具仅供学习和研究使用,请遵守当地法律法规。
2. 部分节点可能由于网络环境不同而表现不同,测试结果仅供参考。
3. 可能需要管理员权限来下载和运行核心程序。
4. 在Windows系统上可能会有防火墙提示需要允许程序访问网络。
## 故障排除
- 如果无法获取节点信息,请检查订阅链接是否有效。
- 如果测试节点时出现错误请确保V2Ray/XRay核心程序正确安装。
- 对于特殊网站的解析问题可能需要安装额外的依赖如BeautifulSoup4
- 如果遇到编码问题,可能需要调整`fetch_content`函数中的编码处理逻辑。
## 贡献
欢迎提交问题报告和改进建议如果您想贡献代码请提交Pull Request。
## 许可
该项目采用MIT许可证。
## 免责声明
本工具仅用于学习和研究网络技术,请勿用于非法用途。使用本工具所产生的任何后果由使用者自行承担。