mirror of
https://github.com/LorenEteval/Furious.git
synced 2026-09-29 10:28:07 +03:00
Update project documentation
Signed-off-by: Loren Eteval <loren.eteval@proton.me>
This commit is contained in:
Loren Eteval
@@ -2,244 +2,28 @@
|
||||
|
||||
[](https://github.com/LorenEteval/Furious/actions/workflows/wheels.yml)
|
||||
|
||||
[简体中文](https://github.com/LorenEteval/Furious#%E5%8A%9F%E8%83%BD)
|
||||
|
||||
A PySide6-based cross platform GUI client that launches your beloved GFW to outer space.
|
||||
Support [Xray-core](https://github.com/XTLS/Xray-core)
|
||||
and [hysteria](https://github.com/apernet/hysteria).
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* Runs on Windows, macOS and Linux.
|
||||
* Built-in support for [Xray-core](https://github.com/XTLS/Xray-core)
|
||||
and [hysteria](https://github.com/apernet/hysteria)(compatible with hy1 and hy2). Cores are actually Python bindings
|
||||
that shipped with the source code. See more
|
||||
information: [Xray-core-python](https://github.com/LorenEteval/Xray-core-python), [hysteria-python](https://github.com/LorenEteval/hysteria-python)
|
||||
and [hysteria2-python](https://github.com/LorenEteval/hysteria2-python).
|
||||
* Support TUN mode on Windows and macOS. (experimental, requires administrator/root privilege)
|
||||
* Support subscription.
|
||||
* Support import from JSON.
|
||||
* Support import from share link:
|
||||
* VMess
|
||||
* VLESS, including [REALITY](https://github.com/XTLS/REALITY)
|
||||
* Shadowsocks
|
||||
* Trojan
|
||||
* Hysteria2
|
||||
* Support export to JSON, share link or QRCode.
|
||||
* Built-in routing mode support: `Bypass Mainland China(with Ads filter)`, `Bypass Iran(with Ads filter)`,
|
||||
[`Route My Traffic Through Tor`](https://github.com/LorenEteval/Furious/wiki/Route-My-Traffic-Through-Tor)
|
||||
and `Global`. You can also choose to customize your own routing rules.
|
||||
* Built-in editor support.
|
||||
* VPN-client user experience.
|
||||
* Support system theme detection and switch to dark/light theme automatically.
|
||||
* Multiple language support: English, Spanish, Simplified Chinese and Traditional Chinese.
|
||||
* Built-in user-friendly feature such as startup on boot.
|
||||
* ...
|
||||
|
||||
## Install
|
||||
|
||||
There are **two** ways of installing Furious:
|
||||
|
||||
1. Download pre-built binary release. In this case there is no dependency required
|
||||
(***Furious will run with compiled code and DLLs***):
|
||||
* For Windows users: Download zip file in the [release](https://github.com/LorenEteval/Furious/releases) page that
|
||||
contains pre-built binaries.
|
||||
* For macOS users: Download dmg file in the [release](https://github.com/LorenEteval/Furious/releases) page. Support
|
||||
Apple Silicon(arm64) and Intel Chip(x86_64).
|
||||
2. Install via `pip` (requires **Python 3.8 and above**, ***Furious will run on native Python***). You need to follow
|
||||
instructions below. (available for **all** platform)
|
||||
|
||||
### Core Building Tools
|
||||
|
||||
> Note: These steps are the same in [Xray-core-python](https://github.com/LorenEteval/Xray-core-python)
|
||||
> or [hysteria-python](https://github.com/LorenEteval/hysteria-python) *Core Building Tools* steps.
|
||||
|
||||
> Note: hysteria requires go 1.21+ to build since v2.0.3
|
||||
|
||||
As mentioned above, cores are shipped as Python bindings to support cross-platform running. So to install Furious
|
||||
via `pip` you must have tools ready for building these bindings for your current platform first. Core building requires:
|
||||
|
||||
* [go](https://go.dev/doc/install) in your PATH. go 1.20.0 and above is recommended. To check go is ready,
|
||||
type `go version`. Also, if google service is blocked in your region(such as Mainland China), you have to configure
|
||||
your GOPROXY to be able to pull go packages. For Chinese users, refer to [goproxy.cn](https://goproxy.cn/) for more
|
||||
information.
|
||||
* [cmake](https://cmake.org/download/) in your PATH. To check cmake is ready, type `cmake --version`.
|
||||
* A working GNU C++ compiler(i.e. GNU C++ toolchains). To check GNU C++ compiler is ready, type `g++ --version`. These
|
||||
tools should have been installed in Linux or macOS by default. If you don't have GNU C++ toolchains(especially for
|
||||
Windows users) anyway:
|
||||
|
||||
* For Linux users: type `sudo apt update && sudo apt install g++` and that should work out fine.
|
||||
* For Windows users: install [MinGW-w64](https://sourceforge.net/projects/mingw-w64/files/mingw-w64/)
|
||||
or [Cygwin](https://www.cygwin.com/) and make sure you have add them to PATH.
|
||||
|
||||
These tools should be installed easily using `brew install` on macOS, or using `sudo apt install` on Linux.
|
||||
|
||||
### Install Furious
|
||||
|
||||
> Note: Install Furious in a Python virtual environment(i.e. venv) is recommended.
|
||||
|
||||
> Note: Furious supports **minimum PySide6 version 6.1.0** since **version 0.2.11**.
|
||||
|
||||
***Hysteria core are now specified as extra dependencies to avoid build problems related to go version***.
|
||||
See [issue #27](https://github.com/LorenEteval/Furious/issues/27). You can install them **depending on your current
|
||||
go version**:
|
||||
|
||||
* `pip install Furious-GUI` will install necessary dependencies, including PySide6, Xray-core, etc.
|
||||
* `pip install "Furious-GUI[go1.20]"` will install extra: `hysteria == 1.3.5`, `hysteria2 == 2.0.0`
|
||||
* `pip install "Furious-GUI[go1.21]"` will install extra: **newest** hysteria2
|
||||
|
||||
To launch Furious, type:
|
||||
|
||||
```
|
||||
Furious
|
||||
```
|
||||
|
||||
## Run From Source
|
||||
|
||||
Clone this repository and enter the project folder. Install requirements:
|
||||
|
||||
> Note: Install requirements in a Python virtual environment(i.e. venv) is recommended.
|
||||
|
||||
> Note: To install requirements successfully you will also need
|
||||
> those [Core Building Tools](https://github.com/LorenEteval/Furious#core-building-tools) above.
|
||||
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
Run:
|
||||
|
||||
```
|
||||
python -m Furious
|
||||
```
|
||||
|
||||
> Note: Furious will ignore current startup on boot request if it's lauched from source.
|
||||
You can install from [release page](https://github.com/LorenEteval/Furious/releases) or
|
||||
from [PyPI](https://pypi.org/project/Furious-GUI/).
|
||||
|
||||
## Wiki
|
||||
|
||||
* [Route My Traffic Through Tor](https://github.com/LorenEteval/Furious/wiki/Route-My-Traffic-Through-Tor)
|
||||
* [TUN Mode](https://github.com/LorenEteval/Furious/wiki/TUN-Mode)
|
||||
* [Install From PyPI](https://github.com/LorenEteval/Furious/wiki/Install-From-PyPI)
|
||||
|
||||
## Build Status
|
||||
## Contribute
|
||||
|
||||
See the build result in [github actions](https://github.com/LorenEteval/Furious/actions).
|
||||
|
||||
| Platform | Python 3.8-Python 3.11 |
|
||||
|--------------|:----------------------:|
|
||||
| ubuntu 20.04 | :heavy_check_mark: |
|
||||
| ubuntu 22.04 | :heavy_check_mark: |
|
||||
| windows-2019 | :heavy_check_mark: |
|
||||
| windows-2022 | :heavy_check_mark: |
|
||||
| macos-11 | :heavy_check_mark: |
|
||||
| macos-12 | :heavy_check_mark: |
|
||||
| macos-13 | :heavy_check_mark: |
|
||||
|
||||
## License
|
||||
|
||||
License under [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE).
|
||||
|
||||
---
|
||||
|
||||
## 功能
|
||||
|
||||
* 在Windows、macOS和Linux上运行。
|
||||
* 内置对[Xray-core](https://github.com/XTLS/Xray-core)和[hysteria](https://github.com/apernet/hysteria)
|
||||
的支持（对于hysteria，兼容hy1和hy2）。Core实际是与源代码一起发行的Python绑定。更多信息: [Xray-core-python](https://github.com/LorenEteval/Xray-core-python),
|
||||
[hysteria-python](https://github.com/LorenEteval/hysteria-python)
|
||||
和[hysteria2-python](https://github.com/LorenEteval/hysteria2-python)。
|
||||
* 在Windows和macOS上支持TUN模式。（实验性功能，需要管理员/root权限）
|
||||
* 支持订阅。
|
||||
* 支持从JSON导入。
|
||||
* 支持从分享链接导入：
|
||||
* VMess
|
||||
* VLESS，包括[REALITY](https://github.com/XTLS/REALITY)
|
||||
* Shadowsocks
|
||||
* Trojan
|
||||
* Hysteria2
|
||||
* 支持导出为JSON、分享链接或二维码。
|
||||
* 内置路由模式支持：`绕过中国大陆（带广告过滤）`、`绕过伊朗（带广告过滤）`、
|
||||
[`通过Tor路由我的流量`](https://github.com/LorenEteval/Furious/wiki/Route-My-Traffic-Through-Tor)
|
||||
和`全球`。也可选择使用自己的路由规则。
|
||||
* 内置编辑器支持。
|
||||
* VPN客户端的使用体验。
|
||||
* 支持系统主题检测并自动切换深色/浅色主题。
|
||||
* 多语言支持：英语、西班牙语、简体中文和繁体中文。
|
||||
* 内置用户友好的功能，例如开机自启动等。
|
||||
* Translations
|
||||
* ...
|
||||
|
||||
## 安装
|
||||
|
||||
有**两种**安装Furious的方式：
|
||||
|
||||
1. 下载打包好的二进制版本，无需其它依赖（***Furious将在编译过的代码和DLL上运行***）：
|
||||
* Windows用户：在[release](https://github.com/LorenEteval/Furious/releases)界面下载打包好的zip文件。
|
||||
* macOS用户：在[release](https://github.com/LorenEteval/Furious/releases)界面下载dmg文件。支持苹果芯片（arm64）和Intel芯片（x86_64）
|
||||
2. 通过`pip`安装（需要**Python 3.8及以上**，***Furious将在本地Python上运行***），且需要按照以下步骤进行操作。
|
||||
（适用于**所有**平台）
|
||||
|
||||
### Core编译工具
|
||||
|
||||
> 注意: 这些步骤与[Xray-core-python](https://github.com/LorenEteval/Xray-core-python)
|
||||
> 和[hysteria-python](https://github.com/LorenEteval/hysteria-python)中*Core Building Tools*一节的步骤一样。
|
||||
|
||||
> 注意: hysteria从v2.0.3开始需要go 1.21+编译
|
||||
|
||||
根据上文所述，Core是对应的Python绑定以支持跨平台运行。所以通过`pip`安装Furious首先得准备好当前平台的Core编译工具。编译Core需要：
|
||||
|
||||
* [go](https://go.dev/doc/install) 在PATH中。推荐go 1.20及以上的版本。要检查go是否就绪，输入`go version`。
|
||||
另外，如果当前所在地区（例如中国大陆）屏蔽了google服务，还需要配置GOPROXY才能拉取go包。对于中国用户，请访问[goproxy.cn](https://goproxy.cn/)
|
||||
了解更多信息。
|
||||
* [cmake](https://cmake.org/download/)在PATH中. 要检查cmake是否就绪，输入`cmake --version`。
|
||||
* GNU C++编译器（即GNU C++工具链）。要检查GNU C++编译器是否准备就绪，输入`g++ --version`
|
||||
。默认情况下，这些工具应该已安装在Linux或macOS中。如果仍然没有GNU C++工具链（特别是对于Windows用户）：
|
||||
|
||||
* 对于Linux用户：输入`sudo apt update && sudo apt install g++`。
|
||||
* 对于Windows用户：安装[MinGW-w64](https://sourceforge.net/projects/mingw-w64/files/mingw-w64/)
|
||||
或[Cygwin](https://www.cygwin.com/)并确保已将它们添加至PATH。
|
||||
|
||||
这些工具可用`brew install`在macOS上安装，或者用`sudo apt install`在Linux上安装。
|
||||
|
||||
### 安装Furious
|
||||
|
||||
> 注意：推荐在Python虚拟环境(i.e. venv)中安装。
|
||||
|
||||
> 注意：Furious从**0.2.11**起支持**最低PySide6版本6.1.0**。
|
||||
|
||||
***Hysteria现在被指定为额外的依赖项，以避免与go版本相关的编译问题***，见
|
||||
[Issue #27](https://github.com/LorenEteval/Furious/issues/27)。可以**根据当前go版本**安装额外依赖:
|
||||
|
||||
* `pip install Furious-GUI`将安装必要的依赖, 包括PySide6, Xray-core, 等
|
||||
* `pip install "Furious-GUI[go1.20]"`将安装额外的依赖：`hysteria == 1.3.5`, `hysteria2 == 2.0.0`
|
||||
* `pip install "Furious-GUI[go1.21]"`将安装额外的依赖：**最新的**hysteria2
|
||||
|
||||
启动Furious，输入：
|
||||
|
||||
```
|
||||
Furious
|
||||
```
|
||||
|
||||
## 从源码运行
|
||||
|
||||
克隆该仓库并进入项目文件夹。安装所需依赖包：
|
||||
|
||||
> 注意：推荐在Python虚拟环境(i.e. venv)中安装依赖。
|
||||
|
||||
> 注意：为了安装依赖包成功，仍然需要准备好上文中的Core编译工具。
|
||||
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
运行:
|
||||
|
||||
```
|
||||
python -m Furious
|
||||
```
|
||||
|
||||
> 注意：如果从源码运行，Furious将忽略当前的开机自启动请求。
|
||||
|
||||
## License
|
||||
|
||||
License under [GPL v3.0](https://github.com/LorenEteval/Furious/blob/main/LICENSE).
|
||||
|
||||
## Credits
|
||||
|
||||
* [Xray-core](https://github.com/XTLS/Xray-core)
|
||||
* [hysteria](https://github.com/apernet/hysteria)
|
||||
* [v2rayN](https://github.com/2dust/v2rayN)
|
||||
* [QDarkStyleSheet](https://github.com/ColinDuquesnoy/QDarkStyleSheet)
|
||||
|
||||
Reference in New Issue
Block a user