Auxio/README.md
OxygenCobalt a34850b9cb
Update codebase
Do a bunch of minor codebase changes that have accumulated.
2021-02-04 16:10:12 -07:00

81 lines
No EOL
4.4 KiB
Markdown

<p align="center"><img src="fastlane/metadata/android/en-US/images/icon.png" width="150"></p>
<h1 align="center"><b>Auxio</b></h1>
<h4 align="center">A sensible and customizable music player for android.</h4>
<p align="center">
<a href="https://github.com/oxygencobalt/Auxio/releases">
<img alt="GitHub release" src="https://img.shields.io/static/v1?label=Tag&message=v1.2.0&color=0D5AF5">
</a>
<a href="https://www.gnu.org/licenses/gpl-3.0">
<img src="https://img.shields.io/badge/License-GPL%20v3-blue.svg">
</a>
<img alt="Minimum SDK" src="https://img.shields.io/badge/API-21%2B-32B5ED">
</p>
<h4 align="center"><a href="/info/FAQ.md">FAQ</a> / <a href="/info/FORMATS.md">Formats</a> / <a href="/info/LICENSES.md">Licenses</a> / <a href="/.github/CONTRIBUTING.md">Contributing</a></h4>
## About
Auxio is a local music player designed to be simple, straightfoward, and customizable. It has a fast, reliable UI/UX, and it is not bloated with useless features. In short, **It plays music.** Auxio is still configurable however, with both the UI and behavior able to be changed to ones liking.
Unlike other music players, Auxio is based off of [ExoPlayer](https://exoplayer.dev/), allowing for much better listening experience compared to the native MediaPlayer API. Auxio's codebase is also designed to be extendable, allowing for the addition of features that are not included in the main app.
I primarily built Auxio for myself, but you can use it too, I guess.
## Screenshots
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot0.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot0.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot1.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot1.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot2.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot2.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot3.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot3.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot4.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot4.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot5.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot5.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot6.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot6.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot7.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot7.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot8.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot8.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/shot9.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/shot9.png)
## Features
- [ExoPlayer](https://exoplayer.dev/) based playback
- Customizable UI & Behavior
- Genres/Artists/Albums/Songs support
- Extensive queue system
- Full playback persistence system
- Edge-to-edge (Oreo+ Only)
- Embedded covers support
- Search Functionality
- Audio Focus / Headset Management
- No internet connectivity whatsoever
- Kotlin from the ground-up
- Modular, feature-based architecture
- No rounded corners
## To Come in the future:
- Translations
- Artist Images
- Artist Songs
- Black theme
- Custom accents
- Playlists
- Liked songs
- More notification actions
- Swipe-between-tracks function (Maybe)
- Better edge-to-edge support
- More customization options
- Other things, presumably
## Contributing
Auxio accepts most contributions as long as they follow the [Contribution Guidelines](/.github/CONTRIBUTING.md).
However, feature additions and major UI changes are less likely to be accepted. See [Accepted Additions](/info/ADDITIONS.md) for more information.
## License
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
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](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.