Build & Installation

This guide explains how to compile and build the AVNC Android app from the source code.

Prerequisites

Ensure your development environment has the following tools installed:

  • Git
  • Android Studio (Koala or newer is recommended)
  • Java Development Kit (JDK): Version 17
  • Android SDK: Target API 35
  • Android NDK: Version 28.2.13676358 (installed via SDK Manager)
  • CMake: Version 3.22.1

Cloning the Repository

AVNC relies on several C/C++ libraries (libvncserver, libjpeg-turbo, and wolfssl) which are included as Git submodules. You must initialize these submodules when cloning.

git clone https://github.com/gujjwal00/avnc.git
cd avnc
git submodule update --init --depth 1

Building with Android Studio

  1. Open Android Studio.
  2. Select Open an existing Android Studio project and navigate to the cloned avnc directory.
  3. Allow Gradle to sync and download the necessary AndroidX dependencies.
  4. Click Run or navigate to Build > Build Bundle(s) / APK(s) > Build APK(s).

Building from the Command Line

If you prefer headless builds or CI/CD pipelines, use the included Gradle wrapper:

# Grant execute permissions to the wrapper script
chmod +x gradlew

# Build a debug APK
./gradlew assembleDebug

# Build a release APK (requires signing configs)
./gradlew assembleRelease

The compiled APKs will be located in the app/build/outputs/apk/ directory.