V2Ray-shell alpha-version

Project description

A GUI for V2Ray-core.
This script is written in PyQt5. It is still under test and the basic functions have been completed.
And PyQt is available for Windows, UNIX/Linux, Mac OS X and the Sharp Zaurus.
That means you can use this script on many platforms.

Before use V2Ray-shell

1. install Python with pip. (pip, which can download and install other Python packages.)
   Python version higher than 3.5 is recommended.
2. install PyQt5 in command line as root or administrator.(Of course you can also use this script on the command line to install PyQt5 as root or administrator permission.)

pip3 install PyQt5

3. in UNIX/Linux, Mac OS X make sure scripts have execute permission. such like below:

chmod +x v2ray-shell.pyw ./src/bridgehouse/bridge.py

How use it

1. run v2ray-shell.pyw
2. in the system tray find v2ray-shell icon, right click show panel.
3. in the v2ray-shell panel, find the menu "options->Preferences", set v2ray file path. and click "aplly and close" button
4. in the v2ray-shell panel, find the menu "File->Add V2Ray-core config file", and add the v2ray-core's config.json file to panel.
5. in the v2ray-shell panel, click the v2ray-shell icon (a darkgreen rocket), enable this config.json.
6. and find the black triangle, click it to run v2ray-core.
7. in the v2ray-shell panel, find the menu "File->Save V2Ray-shell config file", click it to save v2ray-shell config file.

GeoSite.dat File Edit Support (but not perfect complete)

1. python -m pip install protobuf grpcio grpcio-tools
2. this new feature is unstable, you can try another preject https://github.com/onplus/v2ray-SiteDAT

Document and Help

see the wiki page

LICENSE

see the LICENSE file details.