Quick Start

Get your App Key

Register your app at platform.youversion.com to get a free App Key.

Install the SDK modules

Make sure mavenCentral() is included in your repositories, then add the SDK modules to your app-level build.gradle.kts:

build.gradle.kts
dependencies {
    implementation("com.youversion.platform:platform-core:1.+")
    implementation("com.youversion.platform:platform-ui:1.+")
    implementation("com.youversion.platform:platform-reader:1.+")
}

platform-core provides API access, platform-ui provides components such as BibleCard and BibleText, and platform-reader provides the drop-in BibleReader. Include only the modules your app uses, then sync your project with Gradle files.

Configure the SDK

Call YouVersionPlatformConfiguration.configure once during application startup:

SampleApp.kt
import android.app.Application
import com.youversion.platform.core.YouVersionPlatformConfiguration

class SampleApp : Application() {
    override fun onCreate() {
        super.onCreate()
        YouVersionPlatformConfiguration.configure(
            context = this,
            appKey = "YOUR_APP_KEY_HERE",
        )
    }
}

Register that class in your manifest:

AndroidManifest.xml
<application
    android:name=".SampleApp"
    ...>
</application>

Display a Bible passage

BibleCard fetches a passage and renders its reference, text, version, and attribution.

HomeScreen.kt
import androidx.compose.runtime.Composable
import com.youversion.platform.core.bibles.domain.BibleReference
import com.youversion.platform.ui.views.card.BibleCard

@Composable
fun HomeScreen() {
    BibleCard(
        reference = BibleReference(
            versionId = 3034,
            bookUSFM = "JHN",
            chapter = 3,
            verse = 16,
        ),
    )
}