ClashMetaForAndroid README

The project's README from github.com/MetaCubeX/ClashMetaForAndroid. As one markdown file: README.md.

Clash Meta for Android

A Graphical user interface of Clash.Meta for Android

Feature

Feature of Clash.Meta

Get it on F-Droid

Requirement

Build

  1. Update submodules

    git submodule update --init --recursive
    
  2. Install OpenJDK 11, Android SDK, CMake and Golang

  3. Create local.properties in project root with

    sdk.dir=/path/to/android-sdk
    
  4. (Optional) Custom app package name. Add the following configuration to local.properties.

    # config your ownn applicationId, or it will be 'com.github.metacubex.clash'
    custom.application.id=com.my.compile.clash
    # remove application id suffix, or the applicaion id will be 'com.github.metacubex.clash.alpha'
    remove.suffix=true
    
  5. Create signing.properties in project root with

    keystore.path=/path/to/keystore/file
    keystore.password=<key store password>
    key.alias=<key alias>
    key.password=<key password>
    
  6. Build

    ./gradlew app:assembleAlphaRelease
    

Automation

APP package name is com.github.metacubex.clash.meta

Contribution and Project Maintenance

Meta Kernel

Maintenance

ClashMetaForAndroid (MetaCubeX/ClashMetaForAndroid)

Searching Database…

这是干什么的?Clash Meta for Android(CMFA)是 Clash.Meta 的图形界面安卓应用,让你不用手动编辑配置文件,而是通过界面在手机上运行基于规则的代理/VPN 隧道。
这是一个应用,还是要导入我自己项目里的库?它是一个独立的安卓应用(一个你可以安装运行的 APK),不是库——它只是围绕基于 Go 的 Clash.Meta 代理内核做的 Kotlin 图形界面封装。
怎么在我的设备上跑起来?README 里写了从源码自行构建的方法:带子模块克隆仓库,然后运行 `./gradlew app:assembleAlphaRelease` 生成 APK,还可以通过 local.properties 用你自己的 keystore 签名。
我的电脑上需要装些什么才能构建?构建前需要先装好 OpenJDK 11、Android SDK、CMake 和 Golang,因为底层内核是用 Go 编译的。
它能在哪些安卓版本和架构上运行?最低支持 Android 5.0,推荐 Android 7.0 及以上;支持 armeabi-v7a、arm64-v8a、x86 和 x86_64 架构。
其他应用能自动控制 Clash.Meta 吗?可以。外部应用可以向 ExternalControlActivity 发送 intent,来开启、启动或停止 Clash.Meta 服务,也可以通过 clash:// 或 clashmeta:// 链接协议导入配置。
实际的代理内核是从哪来的?CMFA 使用 MetaCubeX/Clash.Meta 的 android-real 分支的内核,这个分支把主 Alpha 分支和安卓专属补丁合并在了一起。
内核出新版本后,怎么和这个安卓应用保持同步?Clash.Meta 内核更新时会自动触发一个 GitHub Action,拉取新版本、更新 Go 依赖,然后创建一个 PR 供审查。
Creator
MetaCubeX
Size
4.6 MB
Stars
47.9K
Age
4y
Commits · 90 Days