A modern cross-platform desktop music player built with Tauri and Vue.js.
Note: If you need online music functionality, you need to start KuGouMusicApi and NeteaseCloudMusicApiBackup at the same time.
Rmusic now supports online music streaming. You can:
- Search and play songs from the KuGou music platform
- Switch between local music and online music within the application
- Enjoy seamless music playback experience even when switching between different pages
- First download and start the KuGouMusicApi and NeteaseCloudMusicApiBackup local proxy server
- Make sure NeteaseCloudMusicApiBackup is running on http://localhost:3000 and KuGouMusicApi is running on http://localhost:3001
- In Rmusic, click the navigation menu to enter the "Online Music" page
- Enter keywords to search for songs and play them
- This project is for learning purposes only. Please respect copyright and do not use this project for commercial activities or illegal purposes!
- Copyright data may be generated during the use of this project. For this copyright data, this project does not own them. To avoid infringement, users must clear the copyright data generated during the use of this project within 24 hours.
- Users are responsible for any direct, indirect, special, incidental or consequential damages (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses) arising from the use of this project or from this agreement or from the use or inability to use this project.
- It is prohibited to use this project in violation of local laws and regulations. The user shall be responsible for any illegal acts caused by using this project knowingly or unknowingly when local laws and regulations do not allow it, and this project shall not bear any direct, indirect, special, incidental or consequential liability arising therefrom.
- Music platforms are not easy, please respect copyright and support genuine versions.
- This project is only used to explore and research technical feasibility, and does not accept any commercial (including but not limited to advertising, etc.) cooperation and donations.
- If the official music platform feels that this project is inappropriate, you can contact this project to change or remove it.
- Cross-platform: Works on Windows, macOS, and Linux
- Lightweight: Built with Rust and Tauri for optimal performance
- Music Folder Scanning: Automatically scans and indexes your music library
- File Format Support: Plays MP3, WAV, OGG, and FLAC audio formats
- Beautiful Interface: Clean and intuitive UI built with Vue.js and Element Plus
- Volume Control: Easily adjust playback volume with slider
- Online Music: Search and play online music through KuGou Music API and NetEase Cloud Music API
- Continuous Playback: Maintains music playback state when switching between different pages
- Dark Mode: Supports dark mode for better user experience in low-light environments
- Immersive Mode: Full-screen playback with beautiful album art and lyrics display
- Lyrics Support: Display synchronized lyrics for both local and online music
- Music Download: Download online music to local storage with cover art and lyrics
- System Tray: Minimize to system tray with quick access controls
- Keyboard Shortcuts: Support for space (play/pause) and arrow keys (next/previous)
- Settings Window: Dedicated settings interface for theme and download preferences
- Auto Theme: Automatically switch between light and dark themes based on time
- Frontend: Vue.js 3, Element Plus UI, Vue Router, Pinia (State Management)
- Backend: Rust, Tauri 2.0
- Audio Playback: Rodio (Rust audio playback library)
- HTTP Client: Reqwest (for online music APIs)
- Async Runtime: Tokio (for asynchronous operations in Rust)
- Build Tools: Vite, Cargo
- UI Components: Element Plus Icons, Custom CSS
- Packaging: Tauri bundler for cross-platform distribution
- Node.js (v16 or higher)
- Rust and Cargo
- npm or yarn
-
Clone the repository
git clone https://github.com/xudong7/tauri-rmusic.git cd tauri-rmusic -
Install dependencies
npm install
-
Run the development version
npm run tauri dev
To build the application for your current platform:
npm run tauri buildThe built application will be available in the src-tauri/target/release directory.
- Launch the application
- Local Music:
- Click "Choose Music Folder" to select a directory containing your music files
- The application will scan the selected folder for supported audio files
- Click on a song from the list to start playback
- Online Music:
- Navigate to the "Online Music" page using the header navigation
- Search for songs using keywords
- Click play button to stream music online
- Use download button to save songs locally
- Playback Controls:
- Use the playback controls to play, pause, and adjust volume
- Use space bar to toggle play/pause
- Use arrow keys to skip to next/previous track
- Immersive Mode:
- Click the album art in the player bar to enter full-screen immersive mode
- View synchronized lyrics and enjoy beautiful visual effects
- Settings:
- Click the settings icon to open preferences window
- Customize theme, download location, and other preferences
We warmly welcome community contributors to join the Rmusic project! 🎵
We welcome all forms of contributions, including but not limited to:
- 🐛 Bug Fixes: Find and fix bugs in the project
- ✨ New Features: Implement new music playback features or UI improvements
- 📝 Documentation: Improve README, comments, or add tutorials
- 🎨 UI/UX Optimization: Interface design improvements and user experience enhancements
- 🌍 Internationalization: Add multi-language support
- 🧪 Testing: Write unit tests or integration tests
- 💡 Suggestions: Propose feature suggestions or improvements in Issues
- Fork this repository to your GitHub account
- Create a feature branch:
git checkout -b feature/amazing-feature - Commit your changes:
git commit -m 'Add some amazing feature' - Push to the branch:
git push origin feature/amazing-feature - Submit a Pull Request
- Follow existing code style and naming conventions
- Write clear comments for new features
- Ensure code passes existing tests
- For major changes, please create an Issue for discussion first
Please refer to the Getting Started section to set up your development environment.
Thank you to all contributors who make Rmusic better! ❤️
- Repeat Modes: playlist repeat, and shuffle modes
- Enhanced Settings Window:
- Library scan preferences
- Cache management options
- Theme Customization: Custom color schemes and accent colors
- Language Support: Internationalization (i18n) for multiple languages
- More Music Sources: Integration with additional music streaming APIs
- Import/Export: Backup and restore music library and playlists
- Notification Support: Now playing notifications with controls
This project is licensed under the MIT License - see the LICENSE file for details.
- Tauri - For the framework to build the desktop application
- Vue.js - For the frontend framework
- Rodio - For audio playback capabilities
- Element Plus - For UI components
- KuGouMusicApi - For enabling online music functionality
- NeteaseCloudMusicApiBackup - For enabling online music functionality