Go to file
Jason A. Donenfeld 4ba87947ae tools: bump wg-go
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
2023-10-22 02:35:16 +02:00
.idea ui: reformat all code 2023-05-05 13:18:30 +02:00
gradle gradle: bump many deps 2023-10-13 21:32:16 +02:00
tunnel tools: bump wg-go 2023-10-22 02:35:16 +02:00
ui ui: sync with crowdin 2023-10-18 14:26:41 +02:00
.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: account for java version updates 2023-05-03 14:23:54 +02:00
build.gradle.kts gradle: upgrade to 8.3 2023-09-12 12:28:02 +05:30
gradle.properties version: bump 2023-10-18 14:26:45 +02:00
gradlew gradle: upgrade to 8.3 2023-09-12 12:28:02 +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_17
    targetCompatibility JavaVersion.VERSION_17
    coreLibraryDesugaringEnabled = true
}
dependencies {
    coreLibraryDesugaring "com.android.tools:desugar_jdk_libs:2.0.3"
}

Translating

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