Awesome
<img src=".github/SOCIAL_PREVIEW.png" alt="Music app screen previews" />Music
A Nothing inspired local music player (based on design by Alkid Shuli (alKid)).
<img height="80" alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png" /> <img height="80" alt="Get it on GitHub" src="./.github/get-it-on-github.png" />
The default branch (dev) is the development version of the repository. For the stable version, see the main branch.
Features
- Supports Android 7+
- Offline-First
- Diverse music organization: Favorites, Playlists, Folder Structure, Albums, Artists
- Background playback w/ media control notification
- Queues
- Theoretical support of these media formats
- Control of where music is found
See potential upcoming features in future updates in this discussion post.
Design
Music is based on the design seen in this comment on the Nothing Community forums, created by Alkid Shuli (alKid).
For information on the goals and ideology of this app, refer to the App Goals & Ideology document.
[!IMPORTANT]
Be careful when clearing the cache of the app as if you accidentally clear the storage, all the data in the app will be deleted (ie: playlists, favorited tracks, artwork).
Built With
Permissions
This (hopefully) lists out all the permissions required by Music based on the permissions asked in the code and values listed out in the App Manifest.
| Permissions | |
|---|---|
| Popups | - Music and Audio (Android 13+)<br/>- Files & Media (Android <13) |
| Implicit | - Read External Storage; for reading Music & Audio Files (unused in Android 13+)<br/>- Write to External Storage (unused in Android 11+)<br/>- Internet (only used for checking for new updates) |
Installation
There are 2 methods of installing this app:
-
Download the APK for your device from a release found in the "Releases" tab.
-
Download the app from the Google Play Store.
[!IMPORTANT]
The APK & Play Store version of the apps aren't compatible as:
- The APK is signed with an upload key.
- The Play Store app is signed with a Google-generated app signing key via "Play App Signing".
To transfer data over between versions, use the "Backup" feature found in the settings page in the app.
Build
Read the Building this App documentation.
FAQ
Why is the APK version of the app larger than the one from the Google Play Store?
You can read this for the full explanation, but in short the APK is built to be used with any device. The version distributed by the Google Play Store is built for your device.
When looking at the App size field under Space used in the storage info for the app, you may notice the size displayed is greater than the download size. This is because what you downloaded is compressed and the app requires an uncompressed version of the libraries to be functional.
Why is loading the app slow?
Read the How Are Tracks Indexed? documentation to see how the app saves tracks.
How do I add music to the app? Why are my music files not displayed?
Read the Where Are Tracks Found? documentation to see how the app finds tracks.
You can look here for the list of supported audio files & metadata formats from the Android documentation.
The loading screen is permanently displayed after moving some music in the "Music" folder!
This is an issue with Android where when we move a folder, the original location might still be cached, which means the folder gets detected in its original location in addition to its new location. This kind of scenario might break some things in the app prior to the logic that gives the ok, saying the saving action is completed.
As mentioned in #36, a work around is to copy the contents you want to move to the desired location (instead of moving the original folder), then delete the content at the original location. You can also go through your file system and see if you end up with duplicate "fake" copies of your moved media.
What platforms are supported?
We officially support Android. Prior to v1.0.0-rc.11, this theoretically should also work for iOS (as this is React Native code), but with the switch to @missingcore/react-native-metadata-retriever which uses an Android-only API, this is no longer the case.
On Android, the app can be installed on all form-factors, however, we guarantee functionality and a better user-experience on "phone" layouts as that's our main audience. We may improve the layout for larger screens in the future.
Legal
This application and code is published under the GNU Affero General Public License v3.0 (https://github.com/MissingCore/Music/blob/main/LICENSE).
Nothing Technology Limited or any of its affiliates, subsidiaries, or related entities (collectively, "Nothing Technology") is a valid licensee and can use this app for any purpose, including commercial purposes, without compensation to the developers of this app. Nothing Technology is not required to comply with the terms of the GNU Affero General Public License v3.0.
This app is developed by cyanChill and is not affiliated with, funded, authorized, endorsed by, or in any way associated with Nothing Technology or any of its affiliates and subsidiaries. Any trademark, service mark, trade name, or other intellectual property rights used in this project are owned by the respective owners.
Licenses of Used Dependencies
Refer to THIRD_PARTY.md.