Go to file
Harsh Shandilya bed2f2e5d6 gradle: convert build files to Kotlin
Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
2023-05-03 00:43:18 +05:30
.idea idea: squelch XML codestyle warning 2022-05-26 06:01:02 +05:30
gradle gradle: convert build files to Kotlin 2023-05-03 00:43:18 +05:30
tunnel gradle: convert build files to Kotlin 2023-05-03 00:43:18 +05:30
ui gradle: convert build files to Kotlin 2023-05-03 00:43:18 +05:30
.gitignore build: remove bespoke signing config properties 2023-04-06 17:16:29 +02:00
.gitmodules tools: clean unwanted ELF flags from binaries 2023-04-05 13:50:57 +02:00
COPYING global: move to Apache 2.0 2018-07-06 16:28:46 +02:00
README.md README: re-add desugaring block 2021-10-29 17:19:00 +02:00
build.gradle.kts gradle: convert build files to Kotlin 2023-05-03 00:43:18 +05:30
gradle.properties gradle: convert build files to Kotlin 2023-05-03 00:43:18 +05:30
gradlew gradle: update wrapper to 8.1.1 2023-04-24 11:22:21 +05:30
settings.gradle.kts gradle: convert build files to Kotlin 2023-05-03 00:43:18 +05:30
sync-crowdin.sh build: add crowdin syncer script and use it 2020-10-14 17:16:36 +02:00

README.md

Android GUI for WireGuard

Download from the Play Store

This is an Android GUI for WireGuard. It opportunistically uses the kernel implementation, and falls back to using the non-root userspace implementation.

Building

$ git clone --recurse-submodules https://git.zx2c4.com/wireguard-android
$ cd wireguard-android
$ ./gradlew assembleRelease

macOS users may need flock(1).

Embedding

The tunnel library is on Maven Central, alongside extensive class library documentation.

implementation 'com.wireguard.android:tunnel:$wireguardTunnelVersion'

The library makes use of Java 8 features, so be sure to support those in your gradle configuration with desugaring:

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
    coreLibraryDesugaringEnabled = true
}
dependencies {
    coreLibraryDesugaring "com.android.tools:desugar_jdk_libs:1.1.5"
}

Translating

Please help us translate the app into several languages on our translation platform.