b7cb6efc4f
Moves service classes into their own files and package for easier organization and discovery No user facing changes in the PR
2.3 KiB
Wholphin developer's guide
See also the Contributing guide for general information on contributing to the project.
Overview
This project is an Android TV client for Jellyfin. It is written in Kotlin and uses the official Jellyfin Kotlin SDK to interact with the server.
The app is a single Activity (MainActivity) with MVVM architecture.
The app uses:
- Compose for the UI
- Navigation 3 for navigating app screen
- Room & DataStore for local data storage
- Hilt for dependency injection
- Media3/ExoPlayer for media playback
- Coil for image loading
- OkHttp for HTTP requests
Getting started
We follow GitHub's fork & pull request model for contributions.
After forking and cloning your fork, you can import the project into Android Studio.
You need a compatible Android Studio version for the configured AGP. This is generally Narwhal 3 Feature Drop | 2025.1.3 or newer. See https://developer.android.com/build/releases/gradle-plugin and `libs.versions.toml.
Code organization
Code is split into several packages:
data- app-specific data models and servicespreferences- Non-UI related code for user settings and preferencesservices- hilt injectable services often used by ViewModels for API callsui- User interface code and ViewModelsutil- Utility classes and functions
FFmpeg decoder module
The app ships with media3 ffmpeg decoder module.
It is not required to build the extension in order to build the app locally.
You can build the module on MacOS or Linux with the ./build_ffmpeg_decoder.sh script. You must have the Android NDK installed.