nym/nym-connect/native/android/README.md

Nym Connect for Android

Prerequisites

TODO

Getting started

Install Android Studio and open the project.
Setup an android emulator using AVD.
Run the project.

⚠ NOTE: be sure to set the build variant to x86_64Debug when running on emulator

Lib Nym socks5

This Application needs the native nym-socks5-listener library in order to work.

To build it for x86_64 and arm64 arch, from the root of the repo run

cd sdk/lib/socks5-listener/
./build-android.sh aarch64 x86_64

To build in release mode run

RELEASE=true ./build-android.sh aarch64 x86_64

The shared library for each ABIs will be automatically moved into app/src/main/jniLibs/* directories.

APK build (from terminal)

This project is setup with multiple product flavors to build for specific architectures.
Supported archs:

• arm64
• arm (old arm)
• x86_64
• x86

For example to build for arm64 in release mode use

./gradlew :app:assembleArm64Release

NOTE: you likely want arch64 (arm64 & x86_64) for APK distribution

To build a universal APK which includes all ABI use

./gradlew :app:assembleUniversalRelease

⚠ WARNING: APK size will be multiplied