aura-music-player
v1.0.1
Published
AURA - A beautiful CoverFlow music player built with Electron
Maintainers
Readme
🎵 AURA Music Player
A beautiful, modern music player built with Electron featuring an immersive CoverFlow interface, real-time audio visualization, and particle effects.
✨ Features
- 🎨 CoverFlow Interface - Swipe through albums with a stunning 3D cover flow effect
- 📊 Audio Visualizer - Real-time frequency visualization that reacts to your music
- ✨ Particle Effects - Dynamic background particles for a mesmerizing experience
- 📝 Queue Management - Smart play queue with shuffle and repeat modes
- 🎧 Multi-Format Support - MP3, WAV, FLAC, M4A, AAC formats
- 🪟 Windows Integration - Set as default music player with file associations
- 🎨 Dynamic Colors - Album artwork extracts colors for a personalized UI
📦 Installation
Option 1: Install via npm (Global)
npm install -g aura-music-playerThen run:
aura-music-playerOption 2: Clone & Run Locally
git clone https://github.com/yourusername/aura-music-player.git
cd aura-music-player
npm install
npm startOption 3: Download Windows Installer
- Download the latest
AURA Music Player Setup.exefrom the Releases page - Run the installer
- Launch from Start Menu or Desktop shortcut
🚀 Building the Windows Installer
npm install
npm run build:winThe installer will be created in the dist/ folder. This installer will:
- ✅ Install AURA Music Player
- ✅ Create desktop & Start Menu shortcuts
- ✅ Register as default player for music files (.mp3, .wav, .flac, .m4a, .aac)
- ✅ Allow custom installation directory
🎮 Usage
Opening Music Files
| Method | Description |
|--------|-------------|
| Drag & Drop | Drag music files or folders into the player |
| File Picker | Click the upload area to browse and select files |
| Command Line | aura-music-player "path\to\music.mp3" |
| File Association | Double-click any music file (if set as default) |
Keyboard Shortcuts
| Key | Action |
|-----|--------|
| Space | Play / Pause |
| ← (Left Arrow) | Previous track |
| → (Right Arrow) | Next track |
| ↑ (Up Arrow) | Volume up |
| ↓ (Down Arrow) | Volume down |
| Mouse Wheel | Scroll through albums |
Playback Controls
- Shuffle - Randomize play order
- Repeat Off - Play through queue once
- Repeat All - Loop the entire queue
- Repeat One - Loop the current track
🪟 Setting as Default Music Player
Method 1: During Installation
Run the installer - it automatically registers file associations.
Method 2: Windows Settings
- Right-click any music file (e.g.,
.mp3) - Select "Open with" > "Choose another app"
- Select "AURA Music Player"
- Check "Always use this app to open .mp3 files"
Method 3: Windows Default Apps
- Press
Win + Ito open Settings - Go to Apps > Default apps
- Scroll down and click "Choose default apps by file type"
- Find
.mp3and select "AURA Music Player"
🛠️ Development
Prerequisites
- Node.js (v18 or higher)
- npm (v9 or higher)
Setup
# Clone the repository
git clone https://github.com/yourusername/aura-music-player.git
cd aura-music-player
# Install dependencies
npm install
# Run in development mode
npm startBuild Commands
# Run in development mode
npm start
# Build for Windows
npm run build:win
# Build without packaging (for testing)
npm run build:dir📁 Project Structure
MUSIC PLAYER/
├── main.js # Electron main process
├── app.js # Renderer process (UI logic)
├── index.html # Main UI layout
├── styles.css # Styling & animations
├── startup.js # Startup script
├── cli.js # CLI entry point for npm global install
├── package.json # Package configuration
├── installer.nsh # NSIS installer script
├── assets/ # Icons and assets
│ └── icon.ico # App icon (required for build)
├── dist/ # Build output (generated)
└── node_modules/ # Dependencies (generated)🎨 Customization
Adding an App Icon
Before building the Windows installer, add your custom icon:
- Create a
128x128or larger.icofile - Save it as
assets/icon.ico
You can convert PNG to ICO using:
- Online tools: icoconvert.com
- Image editors: Photoshop, GIMP, etc.
⚠️ Troubleshooting
"Electron not found" Error
npm install electron --saveApp Won't Start
- Check that all dependencies are installed:
npm install - Ensure you're in the correct directory
- Try deleting
node_modulesand reinstalling
File Associations Not Working
- Run the installer as Administrator
- Manually set default apps in Windows Settings
- Check Registry entries in
HKCU\Software\Classes
📝 License
This project is licensed under the ISC License - see the LICENSE file for details.
🙏 Acknowledgments
- Electron - Framework for building cross-platform desktop apps
- jsmediatags - ID3 tag parser for album artwork
- Inspired by Apple's CoverFlow interface
📧 Contact & Support
- Issues: GitHub Issues
- Discussions: GitHub Discussions
