Getting started
Installation#
This guide provides the steps to initialize and prepare the required tools to create your own provider.
Prerequisites#
Before you start creating a provider, ensure you have:
- Android Studio
- Java Development Kit (JDK)
- Git
- Basic knowledge of Kotlin and Android
- The Flixclusive app (debug or release version)
Initial setup#
Clone the provider template#
- Visit the provider template repository
- Click Use this template → Create a new repository
When using the template, make sure to enable Include all branches. The template’s CI setup depends on the additional branch.
Configure author + repository#
Open the root build.gradle.kts and update the shared provider metadata.
In the template, this is typically set once in a subprojects { ... } block:
subprojects {
flxProvider {
author(
name = "provider-author",
image = "https://github.com/provider-author.png",
socialLink = "https://github.com/provider-author",
)
setRepository("https://github.com/provider-author/my-providers-repo")
}
}Your provider module(s) will still have their own flxProvider { ... } block
for provider-specific settings like id, version, language, and type.
Create or customize a provider module#
This template keeps provider modules under the providers/ folder.
It includes an example provider you can use as a starting point.
You can either:
- Customize
providers/BasicDummyProvider, or - Copy it to a new module folder (e.g.,
providers/TestProvider/)
When creating, deleting, or renaming a provider module, you must also update the
include(...) block in settings.gradle.kts.
For more details, see the provider configuration section.