mirror of
https://github.com/jayfunc/BetterLyrics.git
synced 2026-01-12 19:24:55 +08:00
188 lines
10 KiB
Markdown
188 lines
10 KiB
Markdown
[**中文**](README.CN.md) | **English**
|
|
|
|
<div align="center">
|
|
<img src="BetterLyrics.WinUI3/BetterLyrics.WinUI3/Assets/Logo.png" alt="Logo" width="120">
|
|
|
|
<h1>BetterLyrics</h1>
|
|
|
|
<h4>
|
|
🤩 An elegant and deeply customizable lyrics visualizer & versatile music player <br>
|
|
Built with WinUI3 / Win2D
|
|
</h4>
|
|
|
|
<div>
|
|
<img src="https://img.shields.io/badge/Language-C%23-purple" alt="C#">
|
|
<img src="https://img.shields.io/badge/Framework-WinUI%203-blue" alt="WinUI 3">
|
|
<img src="https://img.shields.io/badge/License-GPL_v3.0-blue" alt="License">
|
|
<a href="https://github.com/jayfunc/BetterLyrics/stargazers"><img src="https://img.shields.io/github/stars/jayfunc/BetterLyrics" alt="Stars"></a>
|
|
<a href="https://crowdin.com/project/betterlyrics"><img src="https://badges.crowdin.net/betterlyrics/localized.svg" alt="Crowdin"></a>
|
|
</div>
|
|
|
|
<br>
|
|
|
|
<img src="Promotion/banner.png" alt="Banner" width="100%" style="border-radius: 10px;">
|
|
|
|
</div>
|
|
|
|
<br>
|
|
|
|
## 🔥 Featured & Community
|
|
|
|
<div align="center">
|
|
|
|
| Featured by HelloGitHub | Featured by SSPAI | 🤖 Ask AI |
|
|
| :---: | :---: | :---: |
|
|
| <a href="https://hellogithub.com/repository/jayfunc/BetterLyrics" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=d2af74f0aea146ad8e4b2086982f5777&claim_uid=SgtQs9c54C8wjnv" alt="HelloGitHub" height="40"></a> | [**Read the Review Article**](https://sspai.com/post/101028) | [](https://deepwiki.com/jayfunc/BetterLyrics) <br> [](https://zread.ai/jayfunc/BetterLyrics) |
|
|
|
|
**Chat Groups:** [QQ Group (1054700388)](https://qun.qq.com/universal-share/share?ac=1&authKey=4Q%2BYTq3wZldYpF5SbS5c19ECFsiYoLZFAIcBNNzYpBUtiEjaZ8sZ%2F%2BnFN0qw3lad&busi_data=eyJncm91cENvZGUiOiIxMDU0NzAwMzg4IiwidG9rZW4iOiJiVnhqemVYN0N5QVc3b1ZkR24wWmZOTUtvUkJoWm1JRWlaWW5iZnlBcXJtZUtGc2FFTHNlUlFZMi9iRm03cWF5IiwidWluIjoiMTM5NTczOTY2MCJ9&data=39UmAihyH_o6CZaOs7nk2mO_lz2ruODoDou6pxxh7utcxP4WF5sbDBDOPvZ_Wqfzeey4441anegsLYQJxkrBAA&svctype=4&tempid=h5_group_info) | [QQ Channel (BetterLyrics4U)](https://pd.qq.com/s/1u1ntkyzr?b=9) | [Discord](https://discord.gg/5yAQPnyCKv) | [Telegram](https://t.me/+svhSLZ7awPsxNGY1)
|
|
|
|
</div>
|
|
|
|
## 🧪 Download & Install
|
|
|
|
<div align="center">
|
|
|
|
| Microsoft Store (Recommended) | Manual Install |
|
|
| :---: | :---: |
|
|
| <a href="https://apps.microsoft.com/detail/9P1WCD1P597R?referrer=appbadge&mode=direct"><img src="https://get.microsoft.com/images/en-us%20dark.svg" width="160"/></a><br>Unlimited free trial (Same as paid) | [**📦 Latest Release (.zip)**](https://github.com/jayfunc/BetterLyrics/releases/latest)<br>See [Installation Guide](https://jayfunc.blog/blog/how-to-install-zip) |
|
|
|
|
[📖 User Guide](https://github.com/jayfunc/BetterLyrics/wiki/User-Guide) | [🔒 Privacy Policy](docs/PrivacyPolicy.md) | [⚖️ Terms of Service](docs/TermsofService.md)
|
|
|
|
</div>
|
|
|
|
## 🌟 Highlighted Features
|
|
|
|
- 🎨 **Stunning Visuals & UI**
|
|
- **Elegant Design:** Smooth, highly personalized style powered by WinUI3 & Win2D.
|
|
- **Immersive Effects:** Fluid backgrounds, 3D/Fan-shaped lyrics, snowflake particles, and more.
|
|
- **Deep Customization:** Configure animations, fonts, and behaviors to your taste.
|
|
|
|
- 🎧 **Versatile Playback & Connectivity**
|
|
- **Built-in Player:** Play from **Local Drives** or stream via **Network Protocols** (SMB, WebDAV).
|
|
- **External Integration:** Visualizes music from Spotify, Apple Music, NetEase, and [many others](https://github.com/jayfunc/BetterLyrics/wiki/User-Guide#known-supported-music-players-configuration-guide).
|
|
|
|
- 🌐 **Advanced Lyrics System**
|
|
- **Offline Translation:** Privacy-focused local machine translation (30+ languages).
|
|
- **Comprehensive Sources:** .lrc (Standard/Enhanced), .eslrc, .ttml, embedded tags, and online sources (QQ Music, NetEase, LRCLIB).
|
|
- **Apple Music:** Supports lyrics fetching (Requires token configuration).
|
|
|
|
- 🪟 **Display Modes for Every Scenario**
|
|
- **Standard:** Full immersive experience.
|
|
- **Docked:** A sleek bar attached to your screen edge.
|
|
- **Desktop Overlay:** Lyrics floating above all apps.
|
|
|
|
- 🧠 **Smart Behaviors**
|
|
- Auto-hides when music pauses.
|
|
|
|
## 🖼️ Screenshots
|
|
|
|
<div align="center">
|
|
|
|
| Standard View | Narrow Mode |
|
|
| :---: | :---: |
|
|
| <img src="docs/assets/screenshots/std.png" width="100%"> | <img src="docs/assets/screenshots/narrow.png" width="100%"> |
|
|
|
|
| Lyrics Visual Effects | Coexisting Modes |
|
|
| :---: | :---: |
|
|
| <img src="docs/assets/screenshots/effect.png" width="100%"> | <img src="docs/assets/screenshots/all-in-one.png" width="100%"> |
|
|
|
|
| Fullscreen Mode | Fullscreen Mode |
|
|
| :---: | :---: |
|
|
| <img src="docs/assets/screenshots/fs3.png" width="100%"> | <img src="docs/assets/screenshots/fs2.png" width="100%"> |
|
|
|
|
| Music Gallery | Playback Statistics |
|
|
| :---: | :---: |
|
|
| <img src="docs/assets/screenshots/music-gallery.png" width="100%"> | <img src="docs/assets/screenshots/stats.png" width="100%"> |
|
|
|
|
</div>
|
|
|
|
## 📹 Demonstration
|
|
|
|
> Watch our demo video (uploaded on 21 Oct 2025) on Bilibili [here](https://www.bilibili.com/video/BV1QRstz1EGt/).
|
|
|
|
## ✍️ Contribute & Build
|
|
|
|
**Help us translate:** Cannot find your language? [Start translating here](https://github.com/jayfunc/BetterLyrics?tab=contributing-ov-file).
|
|
|
|
**Develop Plugins:** Want to extend functionality? [🧩 Read the Developer Guide](docs/PLUGIN_DEV.md).
|
|
|
|
**Build from source:**
|
|
> Before building, ensure you have replaced `DiscordTemplate.cs` and `LastFM.cs` in the `Constants` folder.
|
|
|
|
## 🤑 Donations
|
|
|
|
If you like BetterLyrics, please consider supporting it. Your support helps keep the project alive!
|
|
|
|
<div align="center">
|
|
|
|
| Web Platforms | Alipay (QR) | WeChat (QR) |
|
|
| :---: | :---: | :---: |
|
|
| [PayPal](https://paypal.me/zhefangpay)<br><br>[Buy Me a Coffee](https://buymeacoffee.com/founchoo)<br><br>[爱发电 (Afdian)](https://afdian.com/a/jayfunc) | <img src="docs/assets/donate/Alipay.jpg" width="150"> | <img src="docs/assets/donate/WeChatReward.png" width="150"> |
|
|
|
|
**[View the full Hall of Fame (Sponsors)](SPONSORS.md)**
|
|
|
|
</div>
|
|
|
|
## ⭐ Star History
|
|
|
|
<div align="center">
|
|
<img src="https://api.star-history.com/svg?repos=jayfunc/BetterLyrics&type=Date" width="100%">
|
|
</div>
|
|
|
|
## 📄 License & Credits
|
|
|
|
This project is licensed under the **GNU General Public License v3.0**.
|
|
|
|
<details>
|
|
<summary><b>💖 Special Thanks, Credits & Inspiration</b></summary>
|
|
<br>
|
|
|
|
**Dependencies & References:**
|
|
|
|
| Projects/Packages | Description |
|
|
| :--- | :--- |
|
|
| [Audio Tools Library (ATL) for .NET](https://github.com/Zeugma440/atldotnet) | Used for extracting pictures from music files |
|
|
| [cutlet](https://github.com/polm/cutlet) | Provide the ability for converting Japanese to romaji |
|
|
| [DevWinUI](https://github.com/ghost1372/DevWinUI) | Provide many out-of-the-box features for building WinUI 3 applications |
|
|
| [Isolation](https://github.com/Storyteller-Studios/Isolation) | Dynamic fluid background implementation |
|
|
| [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) | Provide the ability for offline lyrics translation |
|
|
| [lrclib](https://github.com/tranxuanthang/lrclib) | LRCLIB lyrics API provider |
|
|
| [Lyricify-Lyrics-Helper](https://github.com/WXRIW/Lyricify-Lyrics-Helper) | Provide lyrics fetch, decryption, and parsing for QQ, Netease, and Kugou sources |
|
|
| [Manzana-Apple-Music-Lyrics](https://github.com/dropcreations/Manzana-Apple-Music-Lyrics) | Apple Music lyrics fetch using Python |
|
|
| [SpectrumVisualization](https://github.com/Johnwikix/SpectrumVisualization) | Audio visualization reference |
|
|
| [TagLib#](https://github.com/mono/taglib-sharp) | Used for reading the original lyrics content |
|
|
| [Vanara](https://github.com/dahall/Vanara) | Win32 API wrapper |
|
|
| [WinUIEx](https://github.com/dotMorten/WinUIEx) | Provide easy ways to access the Win32 API regarding windowing |
|
|
|
|
See [dependencies](https://github.com/jayfunc/BetterLyrics/network/dependencies) for full list.
|
|
|
|
<br>
|
|
|
|
**💡 Inspired by:**
|
|
|
|
Some design ideas are referenced from the following projects (design inspiration only):
|
|
- [refined-now-playing-netease](https://github.com/solstice23/refined-now-playing-netease)
|
|
- [Lyricify-App](https://github.com/WXRIW/Lyricify-App)
|
|
- [Salt Player](https://moriafly.com/program/salt-player)
|
|
- [MyToolBar](https://github.com/TwilightLemon/MyToolBar)
|
|
|
|
</details>
|
|
|
|
## 💭 Share on Social Media
|
|
|
|
<details>
|
|
<summary><b>Click to expand</b></summary>
|
|
<br>
|
|
<div align="center">
|
|
<img src="https://socialify.git.ci/jayfunc/BetterLyrics/image?description=1&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Light" width="48%">
|
|
<img src="https://opengraph.githubassets.com/<any_hash_number>/jayfunc/BetterLyrics" width="48%">
|
|
</div>
|
|
</details>
|
|
|
|
<br>
|
|
|
|
<div align="center">
|
|
<mark><i>This project is under active development; unexpected issues may occur.</i></mark><br>
|
|
<sub>Disclaimer: This project is provided "as is". All third-party resources belong to their respective owners.</sub>
|
|
</div>
|