elmgates/BetterLyrics
1
0
Fork 0
mirror of https://github.com/jayfunc/BetterLyrics.git synced 2026-01-12 19:24:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Remove outdated FAQ section and integrate relevant content into README.md

Browse Source
This commit is contained in:
Zhe Fang
2025-07-30 18:35:23 -04:00
parent 9036b3be5f
commit df76074ce9
2 changed files with 54 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
FAQ/FAQ.md
View File

@@ -1,59 +0,0 @@
### I couldn't see any button that I can interact with / 我找不到任何可交互的按钮
By default, all the buttons are shown but if you click on the "Immersive" button (as shown in the picture), all the buttons will disappear. But don't worry, one you hover again, it will shown up to you!
默认情况下，所有按钮都会显示，但如果您点击 “沉浸” 按钮（如图左上位置所示），所有按钮都会消失。不过不用担心，当您再次将鼠标悬停在按钮上时，它们就会重新显示出来！
![alt text](image-9.png)
It is important to note that when you enter "Docked Mode", the action buttons are hidden. Hover your mouse over the top to access the "Immerse", "More", and "Close" buttons.
需要特别注意的是，当您进入 “停靠模式” 时，会隐藏操作按钮。将鼠标悬停在顶部以访问 “沉浸” 按钮、“更多” 按钮以及 “关闭” 按钮
![alt text](image-10.png)
Hover the mouse slightly above the bottom edge of the window to display the white control floating window at the bottom
将鼠标悬浮在窗口下边缘稍靠上位置以显示底部控制浮窗小白条
![alt text](image-11.png)
Tap the "little white bar" to display the bottom control bar in floating window form (including current playback progress view, timeline offset adjustment; previous song, pause/play, next song; translation, layout, settings)
点按 “小白条” 即可以浮窗形式显示底部控制栏（包括当前播放进度查看、时间轴偏移调整；上一首、暂停/播放、下一首； 翻译、布局、设置）
![alt text](image-12.png)
### I have set up all the settings related to translation but there is no translation at all
![alt text](image-8.png)
Please make sure that you have already enable "Translation" function (at the bottom-right of the lyrics page, click to toggle).
### How can I lock the window when switching to desktop mode
![alt text](image-6.png)
Again, hover you mouse on the top, click on the lock icon and you're good to go! Or, alternatively, press `Ctrl + Alt + U`.
### How can I unlock the window in desktop mode
![alt text](image-7.png)
It's in the system tray, right-click on the icon and you'll see "Unlock the window". Or, alternatively, press `Ctrl + Alt + U`.
### There's a delay in lyrics timeline
Hover you mouse on the very bottom of the app,
![alt text](image.png)
And then click on the first icon button (Lyrics timeline offset), here you can adjust the offset freely.
### The lyrics jump back and forth frequently / 歌词频繁前后跳动
![alt text](image-2.png)
Go to "Advanced options" section, increase the threshold value (marked with the bigger red rectangle) until the lyrics is working properly.
---

60
README.md
View File

@@ -56,29 +56,33 @@ Check out the article: [BetterLyrics – An immersive and smooth lyrics display
- [LRCLIB](https://lrclib.net/)
- 🎶 **Multiple Music Players Supported**
- <details><summary>NetEase Cloud Music</summary>
- <details><summary>⚠️ NetEase Cloud Music</summary>
- Please install the [BetterNCM plugin](https://microblock.cc/betterncm) first. If a downgrade guide pops up after the installation, please follow the guide to complete the downgrade of NetEase Cloud Music (downgrade to 2.10.13);
- After that, please install the InfLink plugin in PluginMarket. After the installation is complete, please restart NetEase Cloud Music. At this point, all preparatory operations have been completed, enjoy it!
- ⚠️ Please note that there is issues with timeline due to plugin issue
</details>
- <details><summary>Kugou Music</summary>
- <details><summary>⚠️ Kugou Music</summary>
- Please make sure that the Kugou Music setting "Support system playback controls, such as lock screen interface" is turned on
- No timeline information broadcasted, which means when you change timeline position in Kugou Music, BetterLyrics has no way to detect this change.
- ⚠️ Please note that there is issues with timeline due to Kugou itself
</details>
- <details><summary>Apple Music</summary>
- <details><summary>⚠️ Apple Music</summary>
- Make sure you have set timeline threshold to around 600 ms in settings (Go to "Settings" - "Advanced option" to change), otherwise, the lyrics will be moving forward and afterward constantly.
- ⚠️ Please note that you need additional settings to stop from seeing shaking lyrics (see FAQ at the end of this document for more information)
</details>
- <details><summary>foobar2000</summary>
- <details><summary>⚠️ foobar2000</summary>
- Make sure you have https://github.com/dumbie/foo_mediacontrol installed with it
- Please note that there is issues with timeline due to plugin issue
</details>
@@ -211,10 +215,54 @@ Cannot find your language?
Don't worry! Start translating and become one of the contributors! 😆
Click the [link](https://crowdin.com/project/betterlyrics/invite?h=d767e4f2dbd832d8fcdb6f7e5a198b402502866) to translate this app into your language via Crowdin now!
## Star History
## Star history
[![Star History Chart](https://api.star-history.com/svg?repos=jayfunc/BetterLyrics&type=Date)](https://www.star-history.com/#jayfunc/BetterLyrics&Date)
[![](https://api.star-history.com/svg?repos=jayfunc/BetterLyrics&type=Date)](https://www.star-history.com/#jayfunc/BetterLyrics&Date)
## Any issues and PRs are welcomed
If you find a bug please file it in issues or if you have any ideas feel free to share it here.
---
## Frequently asked questions (FAQ)
### I couldn't see any button in dock mode
It is important to note that when you enter "Docked Mode", the action buttons are hidden. Hover your mouse over the top to access the "Immerse", "More", and "Close" buttons.
![alt text](FAQ/image-10.png)
Hover the mouse slightly above the bottom edge of the window to display the white control floating window at the bottom
![alt text](FAQ/image-11.png)
Tap the "little white bar" to display the bottom control bar in floating window form (including current playback progress view, timeline offset adjustment; previous song, pause/play, next song; translation, layout, settings)
![alt text](FAQ/image-12.png)
### How can I lock the window in desktop mode
![alt text](FAQ/image-6.png)
Hover you mouse on the top, click on the lock icon and you're good to go! Or, alternatively, press `Ctrl + Alt + U`.
### How can I unlock the window in desktop mode
![alt text](FAQ/image-7.png)
It's in the system tray, right-click on the icon and you'll see "Unlock the window". Or, alternatively, press `Ctrl + Alt + U`.
### There's a delay in lyrics timeline
Hover you mouse on the very bottom of the app,
![alt text](FAQ/image.png)
And then click on the first icon button (Lyrics timeline offset), here you can adjust the offset freely.
### The lyrics jump back and forth frequently (e.g. Apple Music)
![alt text](FAQ/image-2.png)
Go to "Advanced options" section, increase the threshold value (marked with the bigger red rectangle) until the lyrics is working properly.