Skip to content

README.md

Latest commit

 

History

History
302 lines (232 loc) · 8.97 KB

README.md

File metadata and controls

302 lines (232 loc) · 8.97 KB

AuraMusic

A modern Android music player with YouTube Music integration, powerful audio features, Google Cast support, voice control, and a beautiful Material 3 interface. Works seamlessly on **Android phones, Android TV, and Google TV**.

Screenshots

Release numbers

Latest release GitHub license Downloads


Translation status

We use Weblate to translate AuraMusic. Help us bring AuraMusic to more people!

Translation status

Thank you for helping translate AuraMusic!

Join our community

Discord
Discord 		Telegram
Telegram

Download Now

Get it on GitHub

Table of Contents

Features

Playback & Streaming

  • Play any song or video from YouTube Music
  • Background playback
  • Download and cache songs for offline playback
  • Search for songs, albums, artists, videos and playlists
  • YouTube Music account login support
  • Syncing of songs, artists, albums and playlists from and to your account

Audio Features

  • Equalizer with custom presets
  • Audio normalization
  • Skip silence
  • Adjust tempo/pitch
  • Sleep timer
  • VOSK wake word detection for hands-free voice control

Voice Control

  • Hands-free voice commands (say "Hey Aura" to activate)
  • AEC and noise suppression for accurate detection
  • Voice feedback with TTS
  • Control playback, volume, and search with your voice

Casting & Sharing

  • Google Cast support (Chromecast to TV, speakers, Android TV)
  • Native Android TV / Google TV app with D-pad navigation
  • Listen together with friends in real-time
  • Discord Rich Presence

Lyrics

  • Live synchronized lyrics
  • Multiple sources: Kugou, LRCLib, RushLyrics, BetterLyrics
  • Word-by-word highlighting

Library & Organization

  • Personalized quick picks
  • Library management
  • Local playlist management
  • Import playlists
  • Reorder songs in playlist or queue

UI & Themes

  • Material 3 design
  • Light - Dark - Black - Dynamic theme
  • Home screen widget with playback controls

Integration

  • Shazam music recognition
  • Last.fm scrobbling

Tech Stack

  • Language: Kotlin
  • UI: Jetpack Compose + Material 3
  • Audio: Media3 ExoPlayer
  • Voice: VOSK offline speech recognition
  • DI: Hilt
  • Database: Room
  • Networking: Ktor
  • Image Loading: Coil
  • Casting: Google Cast Framework

Requirements

  • Android 8.0+ (API 26) for phone
  • Android 9.0+ (API 28) for Android TV / Google TV
  • Android Studio Ladybug
  • JDK 21

Quick Start

# Clone the repository
git clone https://github.com/TeamAuraMusic/AuraMusic.git
cd AuraMusic

# Setup API keys (optional)
cp local.properties.example local.properties

# Build for phone
git checkout main
./gradlew assembleDebug

# Build for TV (Android TV / Google TV)
./gradlew assembleFossTvDebug

Build Variants

Variant Description
foss F-Droid compatible, no Google Play Services
gms With Google Cast support, voice features

ABI Variants: universal, arm64, armeabi, x86, x86_64

TV Build: The tv flavor provides a native Android TV / Google TV experience with D-pad optimized navigation.

Example commands:

# Phone universal builds
./gradlew assembleFossUniversalRelease
./gradlew assembleGmsUniversalRelease

# TV universal builds  
./gradlew assembleFossTvUniversalRelease
./gradlew assembleGmsTvUniversalRelease

Support Me

If you'd like to support my work, you can donate via PayPal or Liberapay:

PayPal    Donate using Liberapay

Special Thanks

InnerTune Zion Huang • Malopieds

OuterTune Davide Garberi • Michael Zh

Metrolist MetrolistGroup – Original project this is based on

Contributors

Contributors

Credits:

The open-source community for tools, libraries, and APIs that make this project possible.

Thank you to all the amazing developers who made this project possible!

License

GNU General Public License v3.0 (GPL-3.0) - see LICENSE file

Disclaimer

This project and its contents are not affiliated with, funded, authorized, endorsed by, or in any way associated with YouTube, Google LLC 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.

Made with ❤️ by chila254