pass-with-high-score/blockads-android

Requirements

• Android Studio Ladybug or newer
• JDK 17 or higher
• Android SDK 36 (min SDK 24)
• (Optional - only needed if modifying Go tunnel) Go 1.23+ and gomobile

Steps

[!TIP] Historical versions of the Go binary (tunnel.aar) were committed in the past before being moved to GitHub Releases. To avoid downloading ~1.2GB of old binaries, use blobless clone (--filter=blob:limit=1m) to download only ~20MB.

1. Clone the repository:

   git clone --filter=blob:limit=1m https://github.com/pass-with-high-score/blockads-android.git
   cd blockads-android
   

   (Or for a shallow clone: git clone --depth=1 https://github.com/pass-with-high-score/blockads-android.git)

2. (Optional) Build the Go tunnel AAR/JAR from source (with Android 15 16KB page size support):

   ./scripts/build_tunnel.sh
   # Or
   ./gradlew -Ptunnel.source=local buildGoTunnel
   

   Note: This is completely optional. Gradle automatically resolves a prebuilt, checksum-pinned tunnel.aar from GitHub Releases by default. You do not need Go or NDK unless you are modifying Go code in tunnel/. See docs/TUNNEL.md.

3. Open the project in Android Studio

4. Sync Gradle and run the app on a device or emulator

5. Build from command line:

   ./gradlew assembleDebug
   ./gradlew bundleRelease   # requires signing key
   

---