Auxio/README.md
OxygenCobalt 282933fb37
docs: update docs
Update general user-facing documentation in preperation for 2.0.0.
2021-11-01 17:08:12 -06:00

3.5 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.

Screenshots

Features

  • ExoPlayer based playback
  • Customizable UI & Behavior
  • Genres/Artists/Albums/Songs support
  • Intuitive queue system
  • Reliable playback state persistence
  • Edge-to-edge (Oreo+ Only)
  • 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
  • Improved tablet layouts
  • 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

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.