FlClash Documentation

File: README.md Copy Chapter

简体中文

FlClash Copy Chapter

A multi-platform proxy client based on ClashMeta, simple and easy to use, open-source and ad-free.

on Desktop:

on Mobile:

Features Copy Chapter

✈️ Multi-platform: Android, Windows, macOS and Linux

💻 Adaptive multiple screen sizes, Multiple color themes available

💡 Based on Material You Design, Surfboard-like UI

☁️ Supports data sync via WebDAV

✨ Support subscription link, Dark mode

Use Copy Chapter

Linux Copy Section

⚠️ Make sure to install the following dependencies before using them

sudo apt-get install libayatana-appindicator3-dev
 sudo apt-get install libkeybinder-3.0-dev

Android Copy Section

Support the following actions

com.follow.clash.action.START
 
 com.follow.clash.action.STOP
 
 com.follow.clash.action.TOGGLE

Download Copy Chapter

Homebrew Copy Section

brew tap chen08209/tap
brew install --cask flclash

Build Copy Chapter

1. Update submodules

   bash Copy

   git submodule update --init --recursive

2. Install Flutter and Golang environment

3. Build Application

   • android

     1. Install Android SDK, Android NDK

     2. Set ANDROID_NDK environment variable

     3. Run build script

        bash Copy

        dart setup.dart android

   • windows

     1. Requires a Windows client

     2. Install GCC, Inno Setup

     3. Run build script

        bash Copy

        dart setup.dart windows

   • linux

     1. Requires a Linux client

     2. Dependencies are auto-installed by setup script, or manually:

        bash Copy

        sudo apt-get install -y libayatana-appindicator3-dev libkeybinder-3.0-dev

     3. Run build script

        bash Copy

        dart setup.dart linux

   • macOS

     1. Requires a macOS client

     2. Run build script

        bash Copy

        dart setup.dart macos

Star Copy Chapter

The easiest way to support developers is to click on the star (⭐) at the top of the page.

<a href="https://api.star-history.com/svg?repos=chen08209/FlClash&Date">
    
</a>

File: plugins/window_ext/README.md Copy Chapter

window_ext

A new Flutter plugin project.

Getting Started Copy Chapter

This project is a starting point for a Flutter
plug-in package,
a specialized package that includes platform-specific implementation code for
Android and/or iOS.

For help getting started with Flutter development, view the
online documentation, which offers tutorials,
samples, guidance on mobile development, and a full API reference.

File: plugins/proxy/README.md Copy Chapter

proxy

FlClash's desktop system-proxy integration.

• Windows uses a Flutter method channel and WinINet settings.
• macOS uses /usr/sbin/networksetup for each active network service.
• Linux uses GNOME/MATE gsettings or KDE kwriteconfig based on the active
  desktop environment.

The public Proxy API validates the port, applies HTTP, HTTPS, and SOCKS
settings to 127.0.0.1, and returns false when the selected platform backend
is unavailable or a command fails.

File: README_zh_CN.md Copy Chapter

English

FlClash Copy Chapter

基于ClashMeta的多平台代理客户端，简单易用，开源无广告。

on Desktop:

on Mobile:

Features Copy Chapter

✈️ 多平台: Android, Windows, macOS and Linux

💻 自适应多个屏幕尺寸,多种颜色主题可供选择

💡 基本 Material You 设计, 类Surfboard用户界面

☁️ 支持通过WebDAV同步数据

✨ 支持一键导入订阅, 深色模式

Use Copy Chapter

Linux Copy Section

⚠️ 使用前请确保安装以下依赖

sudo apt-get install libayatana-appindicator3-dev
 sudo apt-get install libkeybinder-3.0-dev

Android Copy Section

支持下列操作

com.follow.clash.action.START
 
 com.follow.clash.action.STOP
 
 com.follow.clash.action.TOGGLE

Download Copy Chapter

Homebrew Copy Section

brew tap chen08209/tap
brew install --cask flclash

Build Copy Chapter

1. 更新 submodules

   bash Copy

   git submodule update --init --recursive

2. 安装 Flutter 以及 Golang 环境

3. 构建应用

   • android

     1. 安装 Android SDK , Android NDK

     2. 设置 ANDROID_NDK 环境变量

     3. 运行构建脚本

        bash Copy

        dart setup.dart android

   • windows

     1. 你需要一个windows客户端

     2. 安装 GCC，Inno Setup

     3. 运行构建脚本

        bash Copy

        dart setup.dart windows

   • linux

     1. 你需要一个linux客户端

     2. 依赖会由 setup 脚本自动安装，也可以手动安装：

        bash Copy

        sudo apt-get install -y libayatana-appindicator3-dev libkeybinder-3.0-dev

     3. 运行构建脚本

        bash Copy

        dart setup.dart linux

   • macOS

     1. 你需要一个macOS客户端

     2. 运行构建脚本

        bash Copy

        dart setup.dart macos

Star Copy Chapter

支持开发者的最简单方式是点击页面顶部的星标（⭐）。

<a href="https://api.star-history.com/svg?repos=chen08209/FlClash&Date">
    
</a>