RGB Lib Kotlin bindings

This project builds an Android library, rgb-lib-android, for the rgb-lib Rust library, which is included as a git submodule. The bindings are created by the rgb-lib-ffi project, which is located inside the rgb-lib submodule.

Usage

To use the Kotlin library add the following to your project gradle dependencies:

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.rgbtools:rgb-lib-android:<version>'
}

Contributing

Build

In docker

In order to build the project, clone it and run:

# Update the submodule
git submodule update --init

Then build the docker image:

# takes a long time and uses a lot of disk space
docker-compose build

Finally start the build container (if your user or group IDs are not 1000, adjust the environment variables MYUID and MYGID in the docker-compose.yml file accordingly):

# will mount the local directory into the docker container
docker-compose up

Local

In order to build the project, setup the following environment variables:

• ANDROID_SDK_ROOT (e.g. export ANDROID_SDK_ROOT=~/Android/Sdk)
• ANDROID_NDK_ROOT (e.g. export ANDROID_NDK_ROOT=$ANDROID_SDK_ROOT/ndk/21.<NDK_VERSION>)

Then, clone this project and run:

# Update the submodule
git submodule update --init

# Add Android rust targets
rustup target add aarch64-linux-android
rustup target add armv7-linux-androideabi
rustup target add x86_64-linux-android

# Build the Android library
./gradlew :android:buildAndroidLib

Publish

To local Maven repository

In order to publish the library to your local Maven repository:

./gradlew :android:publishToMavenLocal --exclude-task signMavenPublication

To Maven Central repository (project maintainers only)

Set your ~/.gradle/gradle.properties signing key values and SONATYPE login

signingKey=<YOUR_GNUPG_ID_LAST_8_CHARS>
signingPassword=<YOUR_GNUPG_PASSPHRASE>
signing.gnupg.keyName=<YOUR_GNUPG_ID>

ossrhUsername=<YOUR_SONATYPE_USERNAME>
ossrhPassword=<YOUR_SONATYPE_PASSWORD>

and then publish by running:

./gradlew :android:publishToSonatype closeAndReleaseSonatypeStagingRepository