Skip to content

orzuzro/Exclave

 
 

Repository files navigation

Exclave

A fork of SagerNet, the universal proxy toolchain for Android written in Kotlin.

Download

Get it on GitHub Get it on F-Droid

Translation

Is Exclave not in your language, or the translation is incorrect or incomplete? Get involved in the translations on Hosted Weblate.

Report issues

Please report issues here. Do not report issues to upstream because the core used is heavily modified.

  • Encrypt with this GPG public key before posting if the issue contains sensitive information.
  • For crashes, log file is required. Switch to "debug" level before logging.
  • For memory leak and high system resource usage, pprof profile is required. Long press "about" and restart the app to trigger pprof settings.

FAQs and explanation of terms

Wiki. The wiki may contain potentially distressing or otherwise sensitive content. Viewer discretion is advised.

Build

  • Install and configure Git, JDK, Android SDK, Android NDK, Go and this Go Mobile fork.
  • git clone this project and submodule library/core. Also clone the corresponding plugin submodules if needed.
  • Replace release.keystore with your own. It can be generated by Java keytool.
  • Append the following lines to your local.properties.
KEYSTORE_PASS=your_keystore_pass
ALIAS_NAME=your_alias_name
ALIAS_PASS=your_alias_pass
  • Build the app:
    • Compile libcore (libgojni.so): ./run lib core.
    • Download assets: ./gradlew :app:downloadAssets (or update assets: ./gradlew :app:updateAssets).
    • Compile the app: ./gradlew :app:assembleOssRelease.
    • APK files are located in app/build/outputs/apk/.
  • Build a plugin:
    • Compile lib[brook|hysteria2|juicity|mieru|tuic5|naive].so: ./run plugin [brook|hysteria2|juicity|mieru|naive].
    • Compile the plugin:./gradlew :plugin:[brook|hysteria2|juicity|mieru|tuic5|naive]:assembleOssRelease.
    • Plugin APK files are located in plugin/[brook|hysteria2|juicity|mieru|tuic5|naive]/build/outputs/apk/.

License

  • When library/core is compiled with with_clash tag, Exclave is licensed under the GNU General Public License as published by the Free Software Foundation, version 3.
Copyright (C) 2023-2025 by dyhkwong
Copyright (C) 2021 by nekohasekai <contact-sagernet@sekai.icu>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
  • When library/core is compiled without with_clash tag, Exclave is licensed under the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  • Plugins are licensed under the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Copyright (C) 2023-2025 by dyhkwong
Copyright (C) 2021 by nekohasekai <contact-sagernet@sekai.icu>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

About

A proxy client derived from SagerNet and powered by a custom fork of v2ray-core.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 87.8%
  • Java 11.2%
  • Shell 0.5%
  • C++ 0.3%
  • AIDL 0.1%
  • Python 0.1%