Auxio/README.md
OxygenCobalt 95e8b06f19
style: extend edge-to-edge on all versions
Extend edge-to-edge to versions below Android Oreo. This is done
through tinting the navigation bar colors on those versions,
circumventing the coloring issue.
2022-01-15 20:12:23 -07:00

3.9 KiB

Auxio

A simple, rational music player for android.

GitHub release Minimum SDK

FAQ | Licenses | Contributing | Architecture

About

Auxio is a local music player with a fast, reliable UI/UX without the many useless features present in other music players. Built off of Exoplayer, Auxio has a much better listening experience compared to other apps that use the native MediaPlayer API. In short, It plays music.

I primarily built Auxio for myself, but you can use it too, I guess.

This branch is the development version of the repository. For a stable version, see the master branch.

Screenshots

Features

  • ExoPlayer based playback
  • Customizable UI & Behavior
  • Genres/Artists/Albums/Songs indexing
  • Reliable playback state persistence
  • ReplayGain support (On MP3, FLAC, OGG, and OPUS)
  • Material You (Android 12+ only)
  • Edge-to-edge
  • Embedded covers support
  • Search Functionality
  • Audio/Headset focus
  • Completely private and offline
  • No rounded album covers

To possibly come in the future:

  • Playlists
  • Liked songs
  • More notification actions
  • And other things, probably

Permissions

  • Storage (READ_EXTERNAL_STORAGE): to read and play your media files
  • Services (FOREGROUND_SERVICE, WAKE_LOCK): to keep the music playing even if the app itself is in background

Building

Auxio relies on a custom version of ExoPlayer that enables some extra features. So, the build process is as follows:

  1. Enter into the project directory
  2. Run python3 prebuild.py, which installs ExoPlayer and it's extensions.
  3. Build the project normally in Android Studio.

Contributing

Auxio accepts most contributions as long as they follow the Contribution Guidelines.

However, feature additions and major UI changes are less likely to be accepted. See Accepted Additions for more information.

License

GNU GPLv3 Image

Auxio is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.