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-uniffi 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 compose.yaml 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/25.<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

To Maven Central repository (project maintainers only)

Create a ~/.jreleaser/config.yml file with the publishing and signing information:

JRELEASER_GITHUB_OWNER: RGB-Tools
JRELEASER_GITHUB_NAME: rgb-lib-kotlin
JRELEASER_GITHUB_TOKEN: fake-token-not-used

JRELEASER_MAVENCENTRAL_USERNAME: "<your-publisher-portal-username>"
JRELEASER_MAVENCENTRAL_PASSWORD: "<your-publisher-portal-password>"

JRELEASER_GPG_PASSPHRASE: "<your-pgp-passphrase>"

JRELEASER_GPG_PUBLIC_KEY: |
  -----BEGIN PGP PUBLIC KEY BLOCK-----

  <contents-of-your-public-key>
  -----END PGP PUBLIC KEY BLOCK-----

JRELEASER_GPG_SECRET_KEY: |
  -----BEGIN PGP PRIVATE KEY BLOCK-----

  <contents-of-your-private-key>
  -----END PGP PRIVATE KEY BLOCK-----

and then publish by running:

./gradlew :android:publish
./gradlew jreleaserDeploy