https://github.com/v2rayroot/v2root
A Python package to manage v2ray with native extensions
https://github.com/v2rayroot/v2root
v2ray v2ray-client vpn vpn-client vpn-manager vpn-service
Last synced: 4 months ago
JSON representation
A Python package to manage v2ray with native extensions
- Host: GitHub
- URL: https://github.com/v2rayroot/v2root
- Owner: V2RayRoot
- License: mit
- Created: 2025-04-03T15:52:28.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-05-13T22:21:29.000Z (5 months ago)
- Last Synced: 2025-05-21T00:19:28.191Z (5 months ago)
- Topics: v2ray, v2ray-client, vpn, vpn-client, vpn-manager, vpn-service
- Language: C
- Homepage: https://v2root.readthedocs.io/en/latest/index.html
- Size: 18.6 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/supported_options.rst
Awesome Lists containing this project
README
# V2Root
A Python package to manage V2Ray proxy configurations with native extensions.
V2Root provides a Python interface to interact with the V2Ray proxy software using a custom C library (`libv2root.dll` on Windows, `libv2root.so` on Linux). It allows users to load configurations, start/stop V2Ray, test connections, and parse VLESS, VMess, and Shadowsocks strings into V2Ray-compatible config files.
## Features
- Load and validate V2Ray configuration files
- Start and stop V2Ray processes
- Test server connections with ping and protocol-specific tests
- Parse VLESS, VMess, and Shadowsocks strings into V2Ray-compatible JSON configs
- Cross-platform support for Windows and Linux
- Comprehensive documentation with examples and troubleshooting
## Installation
Install via pip:
```bash
pip install v2root
```
## Usage
Basic example to start V2Ray with a VLESS configuration:
```python
from v2root import V2ROOT
# Initialize V2ROOT
v2 = V2ROOT()
# Set a VLESS string
vless_str = "vless://your-uuid@your-server:443?security=tls&type=tcp"
v2.set_config_string(vless_str)
# Start V2Ray
v2.start()
# Stop V2Ray when done
v2.stop()
```
## Requirements
- Python 3.6 or higher
- V2Ray executable (v2ray.exe on Windows, v2ray on Linux)
- Windows or Linux OS
- Standard libraries: ctypes, colorama
## Documentation
Detailed documentation, including installation instructions, usage examples, and supported configuration options, is available at:
Read the Docs
## License
This project is licensed under the MIT License - see the file for details.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your changes. See the Contributing Guide for more details.
## What's New
- Fixed Shadowsocks parser
- Resolved service execution issues with the latest V2Ray version on Linux
- Updated Explain Error section for better error handling and user friendly troubleshooting
## Support
If you encounter any issues or have questions, feel free to open an issue on the GitHub repository or join our Support Channel.