Skip to content

README_zh.md

Latest commit

 

History

History
216 lines (158 loc) · 5.34 KB

README_zh.md

File metadata and controls

216 lines (158 loc) · 5.34 KB

VPN Client

🇬🇧 English | 🇷🇺 Русский | 🇹🇭 ไทย | 🇨🇳 中文

VPN 客户端 是一个支持多种内核和协议的跨平台 VPN 客户端。

🚀 主要功能

  • 多协议支持：Xray（VMess、VLESS、Reality、Shadowsocks、Trojan、SSH）、OpenVPN、WireGuard，以及 SOCKS5/HTTP/HTTPS 代理。
  • 跨平台兼容：支持 iOS、Android、macOS、Windows 和 Linux。
  • 高性能：iOS 使用 Swift、Android 使用 Kotlin 开发核心功能，关键组件使用 C++ 和 Golang 编写，确保速度和稳定性。

🖥️ 支持的平台

  • ✅ iOS（15.0 及以上）
  • ✅ Android（5.0 及以上）
  • ✅ macOS（Intel/Silicon）
  • ✅ Windows
  • ✅ Unix（Linux/Debian/Ubuntu）

📦 架构

VPN 客户端的架构分为多个层级：

  1. VPNclient-engine
    各平台通用的核心引擎。负责 VPN 设置与管理、流量路由、操作系统集成以及与 VPN 协议（OpenVPN、WireGuard、Xray 等）的通信。

  2. 平台适配层：

    • VPNclient-engine-flutter
      使用 MethodChannel 与原生代码交互的 Flutter 插件，支持在 Flutter 应用中集成 VPNclient-engine。
    • VPNclient-engine-react-native
      使用 NativeModules 的 React Native 包装器，在 React Native 应用中集成 VPNclient-engine。

  3. VPN 客户端应用
    使用 Flutter 构建的应用，调用上述封装来管理 VPN 会话并显示连接状态。

架构图（点击展开） 
graph TD
  style A fill:#f9d5e5
  A[VPNclient App] --> Z{UI Framework}

  Z -->|Flutter| B[Flutter Plugin]
  Z -->|React Native| C[React Native Plugin]
  Z -->|Native| D[Swift/Kotlin/C++]

  style B fill:#eeac99
  style C fill:#eeac99
  style D fill:#eeac99

  B --> E[VPNclient Engine]
  C --> E
  D --> E

  style E fill:#fbc4ab

  E --> F[iOS]
  E --> G[Android]
  E --> H[macOS]
  E --> I[Windows]
  E --> J[Linux]
Loading

⚙️ 支持的协议

  • VLESS
  • VMess
  • Reality
  • Shadowsocks
  • Hysteria
  • Trojan
  • OpenVPN
  • WireGuard

⚙️ 支持的核心与封装器

🧠 核心支持图（点击展开） 
graph TD
  style A fill:#fbc4ab
  A[VPNclient Engine] --> B{Cores}
  style B fill:#fef9c3

  %% Wrappers
  B --> C[VPNclient Xray Wrapper]
  B --> D[libXray Wrapper]
  B --> E[sing-box Wrapper]
  style C fill:#a0c4ff
  style D fill:#a0c4ff
  style E fill:#a0c4ff

  %% Xray Core
  C --> H[Xray Core]
  D --> H[Xray Core]
  E --> H[Xray Core]
  style H fill:#a0c4ff

  %% Xray Protocols 
  H --> H1[VLESS]
  H --> H2[VMess]
  H --> H3[Reality]
  H --> H4[Shadowsocks]
  H --> H5[Hysteria]
  H --> H6[Trojan]
  style H1 fill:#a0c4ff
  style H2 fill:#a0c4ff
  style H3 fill:#a0c4ff
  style H4 fill:#a0c4ff
  style H5 fill:#a0c4ff
  style H6 fill:#a0c4ff

  %% OpenVPN Core
  B --> F[OpenVPN Core]
  F --> F1[OpenVPN]
  style F fill:#d0f4de
  style F1 fill:#d0f4de

  %% WireGuard Core
  B --> G[WireGuard Core]
  G --> G1[WireGuard]
  style G fill:#ffc6ff
  style G1 fill:#ffc6ff
Loading

🧦 支持的代理驱动

🧵 代理驱动图（点击展开） 
graph TD
  style A fill:#fbc4ab
  A[VPNclient Engine] --> B{Proxy }
  style B fill:#fef9c3

  B --> C[VPN Client Driver]
  B --> D[hev-socks5-tunnel]
  B --> E[tun2socks]
  B --> F[WinTun]

  style C fill:#caffbf
  style D fill:#a0c4ff
  style E fill:#ffc6ff
  style F fill:#ffd6a5
Loading

📂 代码仓库

组件 仓库地址
🌐 VPN 客户端应用（Flutter） VPNclient-app
📱 VPN 客户端引擎（Flutter 插件） VPNclient-engine-flutter
📱 VPN 客户端引擎（React Native 插件） VPNclient-engine-react-native
🤖 VPN 客户端核心引擎 VPNclient-engine

示例应用

💪 为什么选择 VPN 客户端？

  • 🔧 系统级原生集成
  • 🧩 模块化且灵活的架构
  • 💻 开源项目，采用 Extended GPLv3 协议

🛠 入门指南

选择上方适合的仓库，按照其 README.md 中的说明进行操作。

📄 许可证

本项目采用 Extended GPLv3 协议开源。
详见 LICENSE 文件。

📬 联系方式

更多信息请访问官网 🌐 vpnclient.click