WireLing

WireLing is an Android library that wraps wireguard-android with a small public API (WireLingVpn, TunnelConfig, foreground notifications, and stats broadcasts). Kotlin sources live under org.thebytearray.wireling.sdk. The project was renamed and improved from WGAndroidLib; depend on com.github.thebytearray:WireLing (JitPack) instead of the old artifact.

The app module is a sample you can run to enter a WireGuard-style tunnel (interface, keys, peer, endpoint) and connect.

Documentation

Guide	Description
docs/Home.md	Overview and index
docs/Installation.md	Gradle / manifest setup
docs/Quick-Start.md	Channel, icon, permissions, connect
docs/API-Reference.md	WireLingVpn entry points
docs/Configuration.md	TunnelConfig and validation
docs/State-Management.md	Stats broadcast and UI
docs/Troubleshooting.md	Common errors
docs/Architecture.md	Module and layer layout

Quick install (JitPack)

In settings.gradle.kts:

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven("https://jitpack.io")
    }
}

In your app build.gradle.kts:

dependencies {
    implementation("com.github.thebytearray:WireLing:<tag-or-commit>")
}

Replace <tag-or-commit> with a JitPack version.

Build locally

./gradlew :wireling:assembleRelease :app:assembleDebug
./gradlew :wireling:testDebugUnitTest

Namespaces

Module	Android namespace	Kotlin packages
wireling	org.thebytearray.wireling.library	org.thebytearray.wireling.sdk (and internal subpackages)
app	org.thebytearray.wireling.app	Sample: org.thebytearray.wireling.sample

License

WireLing is licensed under the GNU General Public License v3.0. See LICENSE.

“WireGuard” and the WireGuard logo are registered trademarks of Jason A. Donenfeld.