README.md 3.24 KB
Newer Older
1
# Funkwhale for Android™
Antoine POPINEAU's avatar
Antoine POPINEAU committed
2

Ryan Harg's avatar
Ryan Harg committed
3
This is the official Android music player for [Funkwhale](https://funkwhale.audio), native to both Android (developed in Kotlin) and to Funkwhale (uses its native API instead of Subsonic).
4
It is based on the amazing [Otter](https://github.com/apognu/otter) made by [apognu](https://github.com/apognu) and would not be possible without his groundwork!
5

6
You can get help and discuss Funkwhale on Matrix on [#funkwhale-android:matrix.org](https://matrix.to/#/#funkwhale-android:matrix.org).
Antoine POPINEAU's avatar
Antoine POPINEAU committed
7

8
9
## Installation

10
Currently you can install a preview version of Funkwhale for Android™ through a selfhosted [F-Droid repository](https://fdroid.funkwhale.audio/develop/).
11
12
13
You'll have to add this repository to your F-Droid client, please visit the link above for further instructions. Once you added the repository, you can
use F-Droid as usual and search for "Funkwhale". 

Antoine POPINEAU's avatar
Antoine POPINEAU committed
14
15
## State

16
Funkwhale for Android™ is work in Progress. Please bear with us, there will be bugs, there will be crashes and there will be performance and UX issues.
Antoine POPINEAU's avatar
Antoine POPINEAU committed
17

18
Here is the list of Funkwhale for Android™'s features:
Antoine POPINEAU's avatar
Antoine POPINEAU committed
19
20
21
22
23
24
25

 * Basic collection browsing (artists, albums and tracks)
 * Playlists listing
 * Favorites management (listing and add/remove)
 * Track search
 * Queue management
 * Caching of played tracks (played tracks work offline)
Antoine POPINEAU's avatar
Antoine POPINEAU committed
26
 * Download tracks for offline playback
Antoine POPINEAU's avatar
Antoine POPINEAU committed
27
 * Radios playback
Antoine POPINEAU's avatar
Antoine POPINEAU committed
28
29
 * Dark mode! 🎉

30
Funkwhale for Android™ will try to behave as you would expect a mobile music player to. That means it integrates with the OS's media controls (including headset controls) or pause on incoming calls. If there is anything you would like it to do, please [open an issue](https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/issues/new).
Antoine POPINEAU's avatar
Antoine POPINEAU committed
31

32
33
## Screenshots

34
35
36
37
38
39
40
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/1.png" width="200" /> 
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/2.png" width="200" /> 
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/3.png" width="200" /> 
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/4.png" width="200" /> 
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/5.png" width="200" /> 
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/6.png" width="200" /> 
<img src="https://dev.funkwhale.audio/funkwhale/funkwhale-android/-/raw/develop/app/src/main/play/listings/en-US/graphics/phone-screenshots/7.png" width="200" />
41

42
## Translation
Antoine POPINEAU's avatar
Antoine POPINEAU committed
43

44
Funkwhale for Android™ is being translated by the community through [Weblate](https://translate.funkwhale.audio/settings/funkwhale/ffa). If you would like to contribute to its localization or add a new language, you can help out there.
Antoine POPINEAU's avatar
Antoine POPINEAU committed
45

46
[![Translation status](https://translate.funkwhale.audio/widgets/funkwhale/-/ffa/multi-auto.svg)](https://translate.funkwhale.audio/engage/funkwhale/)