mirror of
https://github.com/jayfunc/BetterLyrics.git
synced 2026-01-12 19:24:55 +08:00
249 lines
13 KiB
Markdown
249 lines
13 KiB
Markdown
|
||
|
||
<div align=center>
|
||
<img src="BetterLyrics.WinUI3/BetterLyrics.WinUI3/Assets/Logo.png" alt="" width="96">
|
||
</div>
|
||
|
||
<h2 align=center>
|
||
BetterLyrics
|
||
</h2>
|
||
|
||
<h4 align="center">
|
||
🤩 An elegant and deeply customizable lyrics & player app, built with WinUI3/Win2D
|
||
</h4>
|
||
|
||
<div align="center">
|
||
|
||
[User Guide](https://github.com/jayfunc/BetterLyrics/wiki/User-Guide) | [Privacy Policy](PrivacyPolicy.md) | [Terms of Service](TermsofService.md)
|
||
|
||
</div>
|
||
|
||
<div align=center>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<div align=center>
|
||
|
||
[](https://github.com/jayfunc/BetterLyrics/stargazers)
|
||
[](https://deepwiki.com/jayfunc/BetterLyrics)
|
||
[](https://zread.ai/jayfunc/BetterLyrics)
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
<mark>**_💞 BetterLyrics is made possible by all its contributors, bug reporters and users._**</mark>
|
||
|
||
</div>
|
||
|
||
<div align="center">
|
||
|
||
**_[中文版 README 请点按此处](https://github.com/jayfunc/BetterLyrics/blob/dev/README.CN.md)_**
|
||
|
||
<mark>**_This project is under active development; unexpected issues may occur._**</mark>
|
||
|
||
</div>
|
||
|
||
## 🎉 This project was featured by SSPAI!
|
||
|
||
Check out the article: [BetterLyrics – An immersive and smooth lyrics display tool designed for Windows](https://sspai.com/post/101028).
|
||
|
||
## 🔈 Feedback and chat group
|
||
|
||
[QQ 群](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) (1054700388) | [Discord Server](https://discord.gg/5yAQPnyCKv) | [Telegram Group](https://t.me/+svhSLZ7awPsxNGY1)
|
||
|
||
## 🌟 Highlighted features
|
||
|
||
- 🌠 **Pleasing User Interface**
|
||
- Smooth and highly personalized style, animations and effects
|
||
- Immersive fluid background
|
||
- Perspective/fan-shaped lyrics
|
||
- Snowflake effect
|
||
- Multiple lyrics scrolling functions
|
||
- ... (and more)
|
||
- ↔️ **Strong Lyrics Translation**
|
||
- Offline machine translation (supporting 30+ languages)
|
||
- Auto-reading local lyrics files for embedded translation
|
||
- 🧩 **Various Lyrics Source**
|
||
- 💾 Local storage
|
||
- Music files (with embedded lyrics)
|
||
- [.lrc](<https://en.wikipedia.org/wiki/LRC_(file_format)>) files (with both core format and enhanced format)
|
||
- [.eslrc](https://github.com/ESLyric/release) files
|
||
- [.ttml](https://en.wikipedia.org/wiki/Timed_Text_Markup_Language) files
|
||
- ☁️ Online lyrics providers
|
||
- QQ 音乐
|
||
- 网易云音乐
|
||
- 酷狗音乐
|
||
- [amll-ttml-db](https://github.com/Steve-xmh/amll-ttml-db)
|
||
- [LRCLIB](https://lrclib.net/)
|
||
- <details><summary>⚠️ Apple Music (additional config needed)</summary>
|
||
|
||
- Open the Apple Music web app and the Developer Tools window. Refresh the page. Return to the Developer Tools window, select Fetch/XHR, select a request, find the Media-User-Token header in the request header, and copy its value.
|
||
- Open BetterLyrics and go to the Playback Source settings. Enter the copied value in the Media-User-Token (for Apple Music) setting and click the accept icon on the right-hand side.
|
||
|
||
- 🎶 **Multiple Music Players Supported**
|
||
|
||
- Check it out [here](https://github.com/jayfunc/BetterLyrics/wiki/User-Guide#known-supported-music-players-configuration-guide) for detailed info
|
||
|
||
- 🪟 **Multiple Display Modes**
|
||
- **Standard Mode**
|
||
- Enjoy an immersive listening journey with rich lyrics, animations and beautifully dynamic backgrounds
|
||
- **Docked Mode**
|
||
- A smart animated lyrics bar docked to your screen edge
|
||
- **Desktop Mode**
|
||
- Enjoy immersive lyrics floating above your apps
|
||
- **And More...**
|
||
- Waiting for you to discover...
|
||
- 🧠 **Smart Behaviors**
|
||
- Auto hide when music paused
|
||
|
||
## 🖼️ Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
> ⚠️ Due to GIF format and frame rate limitations, the displayed effect is for preview only. Please refer to the actual device for the actual effect.
|
||
|
||
|
||
|
||
|
||
## 📹 Demonstration
|
||
|
||
Watch our demo video (uploaded on 21 Oct 2025) on Bilibili [here](https://www.bilibili.com/video/BV1QRstz1EGt/).
|
||
|
||
## 🧪 Try it now
|
||
|
||
<a href="https://apps.microsoft.com/detail/9P1WCD1P597R?referrer=appbadge&mode=direct">
|
||
<img src="https://get.microsoft.com/images/en-us%20dark.svg" width="200"/>
|
||
</a>
|
||
|
||
**Unlimited** free trail or purchase (there is **no difference** between free and paid version).
|
||
|
||
If you find it useful, please consider [donating](#-donations) or purchasing it in **Microsoft Store**, I'll appreciate it! 🥰
|
||
|
||
Having trouble downloading and installing from the MS Store? Try the following options:
|
||
- [Download from outside Microsoft Store](https://jayfunc.blog/blog/download-from-outside-ms-store)
|
||
- Go to [latest release](https://github.com/jayfunc/BetterLyrics/releases/latest) and download `.zip` file from `Assets`. (See [this doc](https://jayfunc.blog/blog/how-to-install-zip) for how to install it.)
|
||
|
||
## 🏗️ Build
|
||
|
||
Before you build, make sure that you have already replaced `BetterLyrics\BetterLyrics.WinUI3\BetterLyrics.WinUI3\Constants\LastFMTemplate` with `BetterLyrics\BetterLyrics.WinUI3\BetterLyrics.WinUI3\Constants\LastFM.cs`.
|
||
|
||
## 🤑 Donations
|
||
|
||
If you like this project, please consider supporting it by donating. Your support will help keep the project alive and encourage further development.
|
||
|
||
You can donate via:
|
||
- [PayPal](https://paypal.me/zhefangpay)
|
||
- [Buy Me a Coffee](https://buymeacoffee.com/founchoo)
|
||
- <details><summary>支付宝</summary>
|
||
|
||
|
||
|
||
</detais>
|
||
|
||
- <details><summary>微信</summary>
|
||
|
||
|
||
|
||
</details>
|
||
|
||
This project is made possible by the generous support of our users. **[View the full Hall of Fame](SPONSORS.md)**
|
||
|
||
## 📄 License
|
||
|
||
This project is licensed under the GNU General Public License v3.0. See the [LICENSE](https://github.com/jayfunc/BetterLyrics/blob/dev/LICENSE) file for details.
|
||
|
||
## 💖 Many thanks to
|
||
|
||
Some functions and code are referenced or modified from public repositories, including but not limited to the following open source projects/packages, tutorials, etc., and we would like to express our gratitude to them here.
|
||
|
||
| Projects/Packages | Description |
|
||
| :--- | :--- |
|
||
| [Lyricify-Lyrics-Helper](https://github.com/WXRIW/Lyricify-Lyrics-Helper) | Provide lyrics fetch, decryption, and parsing for QQ, Netease, and Kugou sources |
|
||
| [lrclib](https://github.com/tranxuanthang/lrclib) | LRCLIB lyrics API provider |
|
||
| [Manzana-Apple-Music-Lyrics](https://github.com/dropcreations/Manzana-Apple-Music-Lyrics) | Apple Music lyrics fetch using Python |
|
||
| [Audio Tools Library (ATL) for .NET](https://github.com/Zeugma440/atldotnet) | Used for extracting pictures from music files |
|
||
| [WinUIEx](https://github.com/dotMorten/WinUIEx) | Provide easy ways to access the Win32 API regarding windowing |
|
||
| [TagLib#](https://github.com/mono/taglib-sharp) | Used for reading the original lyrics content |
|
||
| [Vanara](https://github.com/dahall/Vanara) | Win32 API wrapper |
|
||
| [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) | Provide the ability for offline lyrics translation |
|
||
| [Isolation](https://github.com/Storyteller-Studios/Isolation) | Dynamic fluid background implementation |
|
||
| [SpectrumVisualization](https://github.com/Johnwikix/SpectrumVisualization) | Audio visualization reference |
|
||
| [DevWinUI](https://github.com/ghost1372/DevWinUI) | Provide many out-of-the-box features for building WinUI 3 applications |
|
||
| ... | ... |
|
||
|
||
See all the dependencies [here](https://github.com/jayfunc/BetterLyrics/network/dependencies).
|
||
|
||
### Tutorials/Blogs/etc.
|
||
|
||
- [Stackoverflow - How to animate Margin property in WPF](https://stackoverflow.com/a/21542882/11048731)
|
||
- [Bilibili -【WinUI3】SystemBackdropController：定义云母、亚克力效果](https://www.bilibili.com/video/BV1PY4FevEkS)
|
||
- [cnblogs - .NET App 与 Windows 系统媒体控制(SMTC)交互](https://www.cnblogs.com/TwilightLemon/p/18279496)
|
||
- [Win2D 中的游戏循环：CanvasAnimatedControl](https://www.cnblogs.com/walterlv/p/10236395.html)
|
||
- [r2d2rigo/Win2D-Samples](https://github.com/r2d2rigo/Win2D-Samples/blob/master/IrisBlurWin2D/IrisBlurWin2D/MainPage.xaml.cs)
|
||
- [CommunityToolkit - 从入门到精通](https://mvvm.coldwind.top/)
|
||
|
||
## 💡 Inspired by
|
||
|
||
Some design ideas are referenced from the following plugins/software (excluding code that is indirectly or directly referenced or modified, and is only used as a guide for design ideas).
|
||
|
||
- [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)
|
||
|
||
## ✍️ Help us translate into your language
|
||
|
||
Cannot find your language? Or have better translations? Don't worry! Start translating and becoming one of the contributors! 😆
|
||
|
||
Visit https://crowdin.com/project/betterlyrics/invite?h=c9bfb28fce061484883c0891e7a26f9b2592556 to accept the invitation and become a valuable translator now!
|
||
|
||
| Language | Language Code | Contributors |
|
||
| :---: | :---: | :---: |
|
||
| German | de | - |
|
||
| English | en | [jayfunc](https://crowdin.com/profile/jayfunc) |
|
||
| Spanish | es | - |
|
||
| French | fr | - |
|
||
| Japanese | ja | - |
|
||
| Korean | ko | - |
|
||
| Russian | ru | - |
|
||
| Simplified Chinese | zh-Hans | [jayfunc](https://crowdin.com/profile/jayfunc)<br>[borcolasky](https://crowdin.com/profile/borcolasky) |
|
||
| Traditional Chinese | zh-Hant | - |
|
||
|
||
## ⭐ Star history
|
||
|
||
<div style="display: flex; justify-content: space-around; align-items: flex-start;">
|
||
<img src="https://api.star-history.com/svg?repos=jayfunc/BetterLyrics&type=Date)](https://www.star-history.com/#jayfunc/BetterLyrics&Date" width="100%" >
|
||
</div>
|
||
|
||
## 🤗 Any issues and PRs are welcome
|
||
|
||
If you find a bug, please file it in issues, or if you have any ideas, feel free to share them here.
|
||
|
||
## ⚠️ Disclaimer
|
||
|
||
This project is provided "as is" without warranty of any kind.
|
||
|
||
All lyrics, fonts, icons, and other third-party resources are the property of their respective copyright holders.
|
||
The author of this project does not claim ownership of such resources.
|
||
|
||
This project is non-commercial and should not be used to infringe any rights.
|
||
Users are responsible for ensuring their own use complies with applicable laws and licenses.
|
||
|
||
## 💭 Share it on social media
|
||
|
||
|
||
|
||
|