mirror of
https://github.com/jellyfin/jellyfin-android.git
synced 2024-11-30 17:40:40 +00:00
87 lines
3.9 KiB
Markdown
87 lines
3.9 KiB
Markdown
<h1 align="center">Jellyfin Android</h1>
|
|
<h3 align="center">Part of the <a href="https://jellyfin.org">Jellyfin Project</a></h3>
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
|
|
<br/>
|
|
<br/>
|
|
<a href="https://github.com/jellyfin/jellyfin-android">
|
|
<img alt="GPL 2.0 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-android.svg"/>
|
|
</a>
|
|
<a href="https://github.com/jellyfin/jellyfin-android/releases">
|
|
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-android.svg"/>
|
|
</a>
|
|
<a href="https://translate.jellyfin.org/projects/jellyfin-android/jellyfin-android/">
|
|
<img alt="Translation Status" src="https://translate.jellyfin.org/widgets/jellyfin-android/-/jellyfin-android/svg-badge.svg"/>
|
|
</a>
|
|
<br/>
|
|
<a href="https://opencollective.com/jellyfin">
|
|
<img alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/>
|
|
</a>
|
|
<a href="https://features.jellyfin.org">
|
|
<img alt="Feature Requests" src="https://img.shields.io/badge/fider-vote%20on%20features-success.svg"/>
|
|
</a>
|
|
<a href="https://matrix.to/#/+jellyfin:matrix.org">
|
|
<img alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/>
|
|
</a>
|
|
<a href="https://www.reddit.com/r/jellyfin/">
|
|
<img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/>
|
|
</a>
|
|
<br/>
|
|
<a href="https://play.google.com/store/apps/details?id=org.jellyfin.mobile">
|
|
<img width="153" src="https://jellyfin.org/images/store-icons/google-play.png" alt="Jellyfin on Google Play"/>
|
|
</a>
|
|
<a href="https://www.amazon.com/gp/aw/d/B081RFTTQ9">
|
|
<img width="153" src="https://jellyfin.org/images/store-icons/amazon.png" alt="Jellyfin on Amazon Appstore"/>
|
|
</a>
|
|
<a href="https://f-droid.org/en/packages/org.jellyfin.mobile/">
|
|
<img width="153" src="https://jellyfin.org/images/store-icons/fdroid.png" alt="Jellyfin on F-Droid"/>
|
|
</a>
|
|
<br/>
|
|
<a href="https://repo.jellyfin.org/releases/client/android/">Download archive</a>
|
|
</p>
|
|
|
|
Jellyfin Mobile is an Android app that connects to Jellyfin instances and integrates with the [official web client](https://github.com/jellyfin/jellyfin-web).
|
|
We welcome all contributions and pull requests! If you have a larger feature in mind please open an issue so we can discuss the implementation before you start.
|
|
Even though the client is only a web wrapper there are still lots of improvements and bug fixes that can be accomplished with Android and Kotlin knowledge.
|
|
|
|
Most of the translations can be found in the [web client](https://translate.jellyfin.org/projects/jellyfin/jellyfin-web) since it's the base for the Android client as well. Translations for the app can also be improved very easily from our [Weblate](https://translate.jellyfin.org/projects/jellyfin-android/jellyfin-android) instance. Look through the following graphic to see if your native language could use some work!
|
|
|
|
<a href="https://translate.jellyfin.org/engage/jellyfin-android/">
|
|
<img alt="Detailed Translation Status" src="https://translate.jellyfin.org/widgets/jellyfin-android/-/jellyfin-android/multi-auto.svg"/>
|
|
</a>
|
|
|
|
This client was rewritten from scratch with a fresh git history in July to August 2020, and replaces the old Cordova-based client,
|
|
which can still be found [in the archives](https://github.com/jellyfin-archive/jellyfin-android-original).
|
|
|
|
## Build Process
|
|
|
|
### Dependencies
|
|
|
|
- Android SDK
|
|
|
|
### Build
|
|
|
|
1. Clone or download this repository
|
|
|
|
```sh
|
|
git clone https://github.com/jellyfin/jellyfin-android.git
|
|
cd jellyfin-android
|
|
```
|
|
|
|
2. Open the project in Android Studio and run it from there or build an APK directly through Gradle:
|
|
|
|
```sh
|
|
./gradlew assembleDebug
|
|
```
|
|
|
|
### Deploy to device/emulator
|
|
|
|
```sh
|
|
./gradlew installDebug
|
|
```
|
|
|
|
*You can also replace the "Debug" with "Release" to get an optimized release binary.*
|