build.gradle.kts

// BAD
dependencies {
    implementation("io.matthewnelson.kmp-tor:resource-exec-tor:$vKmpTorResource")
    implementation("io.matthewnelson.kmp-tor:resource-exec-tor-gpl:$vKmpTorResource")
}

// BAD
dependencies {
    implementation("io.matthewnelson.kmp-tor:resource-exec-tor:$vKmpTorResource")
    implementation("io.matthewnelson.kmp-tor:resource-noexec-tor-gpl:$vKmpTorResource")
}

// GOOD! (non-gpl)
dependencies {
    implementation("io.matthewnelson.kmp-tor:resource-exec-tor:$vKmpTorResource")
    implementation("io.matthewnelson.kmp-tor:resource-noexec-tor:$vKmpTorResource")
}

// GOOD! (gpl)
dependencies {
    implementation("io.matthewnelson.kmp-tor:resource-exec-tor-gpl:$vKmpTorResource")
    implementation("io.matthewnelson.kmp-tor:resource-noexec-tor-gpl:$vKmpTorResource")
}

Some additional configuration may be necessary for your Android application.

• If utilizing the -exec Android dependency, tor compilations must be extracted to the ApplicationInfo.nativeLibraryDir when the application is installed:

  // build.gradle.kts
  android {
      packaging {
          jniLibs.useLegacyPackaging = true
      }
  }

  // gradle.properties
  android.bundle.enableUncompressedNativeLibs=false

• If running unit tests for Android (not device/emulator), add the following dependency which will provide the desktop compilations and use them in lieu of the android compilations.

  // build.gradle.kts
  dependencies {
      testImplementation("io.matthewnelson.kmp-tor:resource-android-unit-test-tor:$vKmpTorResource")
  
      // Alternatively, if using the `-gpl` variants
  //    testImplementation("io.matthewnelson.kmp-tor:resource-android-unit-test-tor-gpl:$vKmpTorResource")
  }

• Optionally, configure splits for each ABI:

  // build.gradle.kts
  android {
      splits {
          abi {
              isEnable = true
              reset()
              include("x86", "armeabi-v7a", "arm64-v8a", "x86_64")
              isUniversalApk = true
          }
      }
  }

Some additional configuration is necessary for your Android application. tor compilations are not shipped with the resource-exec-tor{-gpl} or resource-noexec-tor{-gpl} Android Native dependencies, they are packaged separately in an .aar and expected to be present at runtime.

• If utilizing the resource-exec-tor{-gpl} Android Native dependency:

  • Add tor compilations to your Android application:

    // build.gradle.kts
    dependencies {
        implementation("io.matthewnelson.kmp-tor:resource-compilation-exec-tor:$vKmpTorResource")
    
        // Alternatively, if using the `-gpl` variants
    //    implementation("io.matthewnelson.kmp-tor:resource-compilation-exec-tor-gpl:$vKmpTorResource")
    }

  • The tor compilations must be extracted to the ApplicationInfo.nativeLibraryDir when the application is installed:

    // build.gradle.kts
    android {
        packaging {
            jniLibs.useLegacyPackaging = true
        }
    }

    // gradle.properties
    android.bundle.enableUncompressedNativeLibs=false

• If utilizing the resource-noexec-tor{-gpl} Android Native dependency:

  • Add libtor compilations to your Android application:

    // build.gradle.kts
    dependencies {
        implementation("io.matthewnelson.kmp-tor:resource-compilation-lib-tor:$vKmpTorResource")
    
        // Alternatively, if using the `-gpl` variants
    //    implementation("io.matthewnelson.kmp-tor:resource-compilation-lib-tor-gpl:$vKmpTorResource")
    }

• Optionally, configure splits for each ABI:

  // build.gradle.kts
  android {
      splits {
          abi {
              isEnable = true
              reset()
              include("x86", "armeabi-v7a", "arm64-v8a", "x86_64")
              isUniversalApk = true
          }
      }
  }

See the frameworks gradle plugin README for more details.

See the filterjar gradle plugin README for more details.

See the npmjs README for more details.