|
1 | | -# VPN Client XRAY Wrapper (vpnclient_xray_wrapper) |
| 1 | +# π VPN Client XRAY Wrapper ('vpnclient_xray_wrapper') |
| 2 | + |
| 3 | +A high-performance VPN client wrapper for Xray-core, designed to provide secure and private internet access. This project implements VPN functionality for Android, iOS, macOS, Windows and Linux platforms. |
| 4 | + |
| 5 | +## π Features |
| 6 | +- π Secure VPN tunneling using Xray-core |
| 7 | +- π Support for multiple protocols (VMess, VLESS, Trojan, etc.) |
| 8 | +- π± Cross-platform implementation (Android/iOS) |
| 9 | +- β‘ Optimized for performance and battery efficiency |
| 10 | +- π οΈ Configurable through simple JSON configuration |
| 11 | + |
| 12 | +## π Requirements |
| 13 | +- π€ Android 6.0+, π iOS 12.0+ |
| 14 | +- β
Appropriate VPN permissions |
| 15 | + |
| 16 | +## π₯ Installation |
| 17 | + |
| 18 | +### π€ Android |
| 19 | +1. π Clone this repository |
| 20 | +2. π Open the project in Android Studio |
| 21 | +3. π¨ Build and run the application |
| 22 | + |
| 23 | +```bash |
| 24 | +git clone https://github.com/VPNclient/VPNclient-xray-wrapper.git |
| 25 | +cd VPNclient-xray-wrapper/android |
| 26 | +./gradlew assembleDebug |
| 27 | +``` |
| 28 | + |
| 29 | +### π iOS |
| 30 | +1. π Clone this repository |
| 31 | +2. π Open the project in Xcode |
| 32 | +3. π¨ Build and run the application |
| 33 | + |
| 34 | +```bash |
| 35 | +git clone https://github.com/VPNclient-repo/VPNclient-xray-wrapper.git |
| 36 | +open VPNclient-xray-wrapper/ios/VPNClient.xcodeproj |
| 37 | +``` |
| 38 | + |
| 39 | +## βοΈ Configuration |
| 40 | +Create a `config.json` file with your Xray-core configuration: |
| 41 | + |
| 42 | +```json |
| 43 | +{ |
| 44 | + "inbounds": [...], |
| 45 | + "outbounds": [...], |
| 46 | + "routing": {...} |
| 47 | +} |
| 48 | +``` |
| 49 | + |
| 50 | +## π Usage |
| 51 | +1. π Place your Xray configuration in the app's documents directory |
| 52 | +2. βΆοΈ Launch the application |
| 53 | +3. π Select your configuration file |
| 54 | +4. π Tap "Connect" to establish the VPN connection |
| 55 | + |
| 56 | + |
| 57 | +## π€ Contributing |
| 58 | +We welcome contributions! Please fork the repository and submit pull requests. |
| 59 | + |
| 60 | +## π License |
| 61 | + |
| 62 | + |
| 63 | +## π¬ Support |
| 64 | +For issues or questions, please open an issue on our GitHub repository. |
0 commit comments