SDK setup with Version Catalog

In this section, you’ll find detailed instructions for setting up the Kotzilla SDK using the Gradle Version Catalog if you are using it to manage the dependencies and plugins of your application.

This section replaces the "Update Gradle Files" steps described in the default Kotzilla SDK setup guides for Android, KMP and SDK libraries

note

Remember to register your app and download the kotzilla.json file before configuring the Kotzilla SDK using the Gradle Version Catalog. You will also need to initialize the Kotzilla SDK in your app or library after completing the Version Catalog configuration, as described in the Kotzilla SDK setup guides.

info

Kotzilla SDK is available on both Maven Central and the Kotzilla public repository. However, when using the Version Catalog, it is recommended to use the Kotzilla public repository to resolve dependencies correctly. More information on how to configure access to the Kotzilla repository is available here

Update libs.versions.toml

To set up the SDK using the Version Catalog, add the following lines to your libs.versions.toml file:

[versions]
kotzilla = "1.0.1"

[libraries]
kotzilla-sdk = {group = "io.kotzilla", name = "kotzilla-sdk", version.ref = "kotzilla" }
# if needed ktor3 only
# kotzilla-sdk-ktor3 = {group = "io.kotzilla", name = "kotzilla-sdk-ktor3", version.ref = "kotzilla" }
kotzilla-plugin = {group = "io.kotzilla", name = "kotzilla-plugin", version.ref = "kotzilla" }

[plugins]
kotzilla = { id  = "io.kotzilla.kotzilla-plugin", version.ref = "kotzilla" }

note

Make sure that all three sections above are included

Root Project - build.gradle.kts

Set up the Kotzilla Plugin in your project (root-level) Gradle file (<project>/build.gradle.kts) using the buildscript section. Add classpath(libs.kotzilla.plugin) in your dependencies block:

buildscript {
		// Kotzilla Plugin
    dependencies {
        classpath(libs.kotzilla.plugin)
    }
}

plugins {
	// ...
	alias(libs.plugins.kotzilla) apply false
}

info

The buildscript { } section must be added before your plugins { } section

App Level - build.gradle.kts

Configure your module (app-level) Gradle file (<project>/<app-module>/build.gradle.kts) with Version Catalog Gradle dependencies, within plugins section and dependencies section:

plugins {
    // others plugins ...
    
    alias(libs.plugins.kotzilla)
}

dependencies {
    implementation(libs.kotzilla.sdk)
    // if you use ktor3
    // implementation(libs.kotzilla.sdk.ktor3)
}

Sync your project with your Gradle configuration. Your dependencies should now resolve correctly.