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…

47.9K ·GitHub
ClashMetaForAndroid
Что это такое?Clash Meta for Android (CMFA) — это графическое Android-приложение для Clash.Meta: оно позволяет запускать на телефоне прокси/VPN-туннель с правилами через удобный интерфейс, а не править файлы конфигурации вручную.
Это отдельное приложение или библиотека, которую я могу подключить в свой проект?Это самостоятельное Android-приложение (APK, который вы устанавливаете и запускаете), а не библиотека — по сути, это графическая оболочка на Kotlin вокруг прокси-ядра Clash.Meta, написанного на Go.
Как запустить его на своём устройстве?В README описана сборка из исходников: склонируйте репозиторий вместе с субмодулями, затем выполните `./gradlew app:assembleAlphaRelease`, чтобы получить APK; при желании его можно подписать своим keystore, указанным в local.properties.
Что нужно установить на компьютере для сборки?Перед сборкой нужно установить OpenJDK 11, Android SDK, CMake и Golang, поскольку само ядро компилируется из кода на Go.
На каких версиях Android и архитектурах это работает?Минимально поддерживается Android 5.0, рекомендуется Android 7.0 и выше; поддерживаются архитектуры armeabi-v7a, arm64-v8a, x86 и x86_64.
Могут ли другие приложения управлять Clash.Meta автоматически?Да, сторонние приложения могут отправлять intent'ы в ExternalControlActivity, чтобы включать, запускать или останавливать сервис Clash.Meta, а также импортировать профиль по ссылке со схемой clash:// или clashmeta://.
Откуда берётся само прокси-ядро?CMFA использует ядро из ветки android-real репозитория MetaCubeX/Clash.Meta, в которой основная ветка Alpha объединена с патчами специально для Android.
Как новые версии ядра попадают в это Android-приложение?GitHub Action срабатывает автоматически при обновлении ядра Clash.Meta: подтягивает новую версию, обновляет Go-зависимости и создаёт PR на проверку.
What are similar projects?clash, panda-vpn-pro, WhiteAestherMobile, v2rayNG, BPB-Worker-Panel, mlmvpn_android, edgetunnel, karing
Which topics is it in?shadowsocksr, clash-meta, proxy-server, vpn-client, mihomo, gfw, socks5, v2ray, tunnel, anti-censorship, censorship-circumvention, android-app
Creator
MetaCubeX
Size
4.6 MB
Stars
47.9K
Updated
CommitOct 11Releasev2.11.35Sep 30
Age
4y
Commits · 90 Days