mirror of
https://github.com/Qv2ray/Qv2ray.git
synced 2025-05-21 03:10:24 +08:00
137 lines
8.8 KiB
Markdown
137 lines
8.8 KiB
Markdown
***注意：Qv2ray 仅能用于 Qt/c++/linux/CI/自动化 等相关技术的学习和在法律允许范围内的使用，任何个人或集体不得使用 Qv2ray 进行任何违反相关法律法规的操作。***
|
||
|
||
*任何尝试下载或下载 Qv2ray 任意分支或发行版即代表您同意本项目作者不承担任何由于您违反以上准则所带来的任何法律责任。*
|
||
|
||
# Qv2ray
|
||
|
||
[](https://app.codacy.com/app/lhy0403/Qv2ray?utm_source=github.com&utm_medium=referral&utm_content=lhy0403/Qv2ray&utm_campaign=Badge_Grade_Dashboard) [](http://hits.dwyl.io/lhy0403/Qv2ray)
|
||
|
||
使用 Qt 框架的跨平台 v2ray 客户端. 支持 Windows, Linux, macOS
|
||
|
||
支持连接编辑，支持导入任意配置和 `vmess://` 分享链接
|
||
|
||
Special thanks to: [Hv2ray](https://github.com/aliyuchang33/Hv2ray) by [@aliyuchang33](https://github.com/aliyuchang33)
|
||
|
||
## 相关链接：
|
||
|
||
- **功能介绍: https://lhy0403.github.io/Qv2ray**
|
||
- 最新 **[Release 发布版](https://github.com/lhy0403/Qv2ray/releases/latest)**
|
||
- Crowdin 翻译平台, Translations are welcome at here: **[Public Translation Platform](https://crwd.in/qv2ray)**
|
||
- ArchLinux - AUR: **[qv2ray](https://aur.archlinux.org/packages/qv2ray/)**
|
||
- **[qv2ray-dev-git](https://aur.archlinux.org/packages/qv2ray-dev-git)**: `dev` 分支的开发版本，由 **[@axionl](https://github.com/axionl)** 维护
|
||
|
||
### 首次使用请查看 ➡ [用户手册](https://lhy0403.github.io/Qv2ray)
|
||
|
||
|
||
|
||
## Qv2ray 项目状态
|
||
|
||
### Jenkins CI
|
||
|
||
- 访问链接: [https://jenkins.lhy0403.top/](https://jenkins.lhy0403.top/)
|
||
|
||
| | Master | Development | Versioning-V1 | Pull Requests |
|
||
| -------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||
| Linux AppImage | [](https://jenkins.lhy0403.top/job/Qv2ray-AppImage-Release/) | [](https://jenkins.lhy0403.top/job/Qv2ray-AppImage-Dev/) | [](https://jenkins.lhy0403.top/job/Qv2ray-AppImage-Version1/) | [](https://jenkins.lhy0403.top/job/Qv2ray-AppImage-PullRequest/) |
|
||
| Windows | [](https://jenkins.lhy0403.top/job/Qv2ray-Win32-Release/) | [](https://jenkins.lhy0403.top/job/Qv2ray-Win32-Dev/) | [](https://jenkins.lhy0403.top/job/Qv2ray-Win32-Version1/) | [](https://jenkins.lhy0403.top/job/Qv2ray-Win32-PullRequest/) |
|
||
|
||
### Travis & Appveyor
|
||
|
||
*Travis per machine badge provided by: [badge-matrix](https://github.com/exogen/badge-matrix)*
|
||
|
||
| OS | 主分支 [master](https://github.com/lhy0403/Qv2ray/tree/master) | 开发分支 [dev](https://github.com/lhy0403/Qv2ray/tree/dev) | 版本分支 [version-v1](https://github.com/lhy0403/Qv2ray/tree/version-v1) |
|
||
| --------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||
| [Linux](https://travis-ci.com/lhy0403/Qv2ray) |  |  |  |
|
||
| [macOS](https://travis-ci.com/lhy0403/Qv2ray) |  |  |  |
|
||
| [Windows](https://ci.appveyor.com/project/lhy0403/qv2ray) | [](https://ci.appveyor.com/project/lhy0403/qv2ray/branch/master) | [](https://ci.appveyor.com/project/lhy0403/qv2ray/branch/dev) | [](https://ci.appveyor.com/project/lhy0403/qv2ray/branch/version-v1) |
|
||
|
||
|
||
|
||
## 编译
|
||
|
||
### 依赖环境
|
||
|
||
|
||
- 框架依赖：`Qt >= 5.12` （5.9 可以编译成功但是不建议使用）
|
||
- 编译依赖：`gcc >= 8` 或 `MinGW` (Windows) 或 `clang` (macOS)
|
||
|
||
- 建议使用 QtCreator，以获得最佳编译环境
|
||
|
||
### Linux & macOS
|
||
|
||
- 对于 macOS，需要额外使用 HomeBrew 安装 Qt 并正确设定 $PATH 环境变量
|
||
- 或者使用 Qt 官方包和 XCode
|
||
- 对于 Linux，请根据不同发行版安装对应的 Qt 开发包
|
||
- Arch Linux 用户也可从 **[qv2ray-dev-git](https://aur.archlinux.org/packages/qv2ray-dev-git)** 拉取 `dev` 分支并构建
|
||
- 手动构建方法：
|
||
|
||
```bash
|
||
git clone --recursive https://github.com/lhy0403/Qv2ray && cd Qv2ray
|
||
|
||
# 按需要签出开发分支
|
||
# git checkout dev
|
||
|
||
mkdir build && cd build
|
||
qmake ../
|
||
make
|
||
```
|
||
|
||
### Windows
|
||
|
||
- 建议使用 Qt Creator
|
||
|
||
```batch
|
||
REM 首先把 %QTROOT%/bin 和 MinGW/bin 文件夹添加到 PATH 环境变量
|
||
REM SET PATH=%PATH%;C:\Qt\5.13.0\mingw73_32\bin\;C:\Qt\Tools\mingw730_32\bin\
|
||
|
||
SET PATH=%PATH%;Qt安装目录\Qt版本号\编译器类型\bin;Qt安装目录\Tools\编译器类型\bin
|
||
|
||
git clone --recursive https://github.com/lhy0403/Qv2ray && cd Qv2ray
|
||
REM git checkout dev （可选项，用于测试 dev 分支）
|
||
|
||
mkdir build && cd build
|
||
qmake ../
|
||
mingw32-make.exe
|
||
```
|
||
|
||
|
||
|
||
## Contributors
|
||
|
||
| Name (@GithubAccount) | Contributions |
|
||
| ------------------------------------------------------------ | ------------------------------- |
|
||
| Leroy.H.Y [@lhy0403](https://github.com/lhy0403) | Qv2ray Current Maintainer |
|
||
| Hork [@aliyuchang33](https://github.com/aliyuchang33) | Hv2ray Initial Idea and Designs |
|
||
| SOneWinstone [@SoneWinstone](https://github.com/SoneWinstone) | HTTP Request Helper |
|
||
| ArielAxionL [@axionl](https://github.com/axionl) | Qv2ray Art Work |
|
||
| TheBadGateway [@thebadgateway](https://github.com/thebadgateway) | Russian Translation |
|
||
|
||
|
||
|
||
## License
|
||
|
||
Qv2ray is licensed under [](https://www.gnu.org/licenses/gpl-3.0)
|
||
|
||
[X2Struct](https://github.com/xyz347/x2struct) is licensed 
|
||
|
||
```
|
||
Qv2ray, A Qt frontend for v2ray. Written in c++
|
||
Copyright (C) 2019 Leroy.H.Y (@lhy0403) ---> Qv2ray Current Maintainer
|
||
Copyright (C) 2019 Hork (@aliyuchang33) ---> Hv2ray Initial Idea and Designs
|
||
Copyright (C) 2019 SOneWinstone (@SoneWinstone) ---> Hv2ray/Qv2ray HTTP Request Helper
|
||
Copyright (C) 2019 ArielAxionL (@axionl) ---> Qv2ray ArtWork
|
||
|
||
This program is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation, either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
```
|