An open API service indexing awesome lists of open source software.

https://github.com/q7df1/xrayfa

XrayFA is a powerful and user-friendly Android client for Xray-core.
https://github.com/q7df1/xrayfa

android-app hysteria2 shadowsocks trojan tun2socks vless vmess vpn-client xray-core

Last synced: about 2 months ago
JSON representation

XrayFA is a powerful and user-friendly Android client for Xray-core.

Awesome Lists containing this project

README

          

# ๐Ÿš€ XrayFA

**A modern, powerful, and user-friendly Android client for [Xray-core](https://github.com/XTLS/Xray-core).**

XrayFA provides a secure, high-speed proxy experience with a focus on simplicity and performance.


English | ็ฎ€ไฝ“ไธญๆ–‡ | ะ ัƒััะบะธะน | ํ•œ๊ธ€

[![GitHub release](https://img.shields.io/github/v/release/Q7DF1/XrayFA?style=flat-square&color=blue)](https://github.com/Q7DF1/XrayFA/releases)
[![GitHub license](https://img.shields.io/github/license/Q7DF1/XrayFA?style=flat-square)](https://github.com/Q7DF1/XrayFA/blob/main/LICENSE)
[![GitHub top language](https://img.shields.io/github/languages/top/Q7DF1/XrayFA?style=flat-square)](https://github.com/Q7DF1/XrayFA)
[![GitHub stars](https://img.shields.io/github/stars/Q7DF1/XrayFA?style=flat-square)](https://github.com/Q7DF1/XrayFA/stargazers)

---

## ๐Ÿ“ธ Screenshots


Phone UI








Tablet / Foldable UI



---

## โœจ Features

### ๐Ÿ“ก Protocol Support
| VLESS | VMESS | Shadowsocks | Trojan | Hysteria2 |
| :---: | :---: | :---: | :---: | :---: |
| โœ… | โœ… | โœ… | โœ… | โœ… |

### ๐Ÿ› ๏ธ Core Capabilities
* **Subscription Management**: Easily import, manage, and batch-update subscription links.
* **Intuitive Dashboard**: Clean real-time monitoring of connection status, speed, and traffic.
* **Rich Configuration**: Advanced routing rules and DNS settings for power users.
* **Smooth UX**: Modern Material Design 3 interface with fluid animations and Dark Mode support.
* **Stable Engine**: Built on the latest **Xray-core** for maximum compatibility and security.

---

## ๐Ÿ“ฅ Download

Ready to get started?



Get it on GitHub


Get it on F-Droid

---

## ๐Ÿ”จ Build from Source

### Prerequisites
* **Android Studio**: Latest stable version.
* **JDK**: 11 or higher.
* **Go (Golang)**: 1.21+ (Required for Xray-core compilation).
* **Git**: For cloning submodules.

### Build Steps

1. **Clone the repository** (with submodules):
`
git clone --recursive https://github.com/Q7DF1/XrayFA.git
cd XrayFA
`
*If you missed submodules:* `git submodule update --init --recursive`

2. **Open in Android Studio**:
Select the `XrayFA` folder and wait for Gradle sync.

3. **Build and Run**:
Connect your device and press **Shift + F10**.

> [!CAUTION]
> ๐Ÿšจ **IMPORTANT**: For accurate performance testing, ensure the build configuration is set to **RELEASE**. [Learn more about Compose performance](https://medium.com/androiddevelopers/why-should-you-always-test-compose-performance-in-release-4168dd0f2c71).

---

## ๐Ÿ“– Quick Start

1. **Import Configuration**:
* Click the **+** button to import from Clipboard (`vless://`, `vmess://`, etc.).
* Or scan a **QR Code**.
2. **Manage Subscriptions**:
* Navigate to **Subscription Settings** to add provider URLs.
3. **Connect**:
* Select a node and tap the **Floating Action Button**.
* Accept the VPN permission request.

---

## ๐Ÿ”— Credits & Acknowledgements

Special thanks to these projects that make XrayFA possible:
* [Xray-core](https://github.com/XTLS/Xray-core) - The core network engine.
* [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite)
* [hev-socks5-tunnel](https://github.com/heiher/hev-socks5-tunnel)

## ๐Ÿ“„ License

Distributed under the **Apache-2.0 License**. See [LICENSE](LICENSE) for details.

---

### ๐ŸŒŸ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=q7df1/xrayFA&type=Date)](https://star-history.com/q7df1/xrayFA)