Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tranxuanthang/lrcget
Utility for mass-downloading LRC synced lyrics for your offline music library.
https://github.com/tranxuanthang/lrcget
javascript linux lyrics music music-player rust synced-lyrics tauri tauri-app vue vue3 windows
Last synced: about 2 months ago
JSON representation
Utility for mass-downloading LRC synced lyrics for your offline music library.
- Host: GitHub
- URL: https://github.com/tranxuanthang/lrcget
- Owner: tranxuanthang
- License: mit
- Created: 2022-11-14T11:09:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-14T02:42:08.000Z (2 months ago)
- Last Synced: 2024-07-14T03:34:42.251Z (2 months ago)
- Topics: javascript, linux, lyrics, music, music-player, rust, synced-lyrics, tauri, tauri-app, vue, vue3, windows
- Language: Vue
- Homepage:
- Size: 1.28 MB
- Stars: 565
- Watchers: 10
- Forks: 21
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# LRCGET
Utility for mass-downloading LRC synced lyrics for your offline music library.
LRCGET will scan every files in your chosen directory for music files, then and try to download lyrics to a LRC files having the same name and save them to the same directory as your music files.
LRCGET is the official client of [LRCLIB](https://lrclib.net) service.
## Download
🎉 Latest version: v0.4.0
Visit the [release page](https://github.com/tranxuanthang/lrcget/releases) to download.
OS Support:
- [x] Windows 10
- [x] Linux (Ubuntu 22.04 and AppImage build)
- [x] macOS
Known issues:
- The DEB build cannot be installed on Ubuntu 24.04. Please use the AppImage build instead for Ubuntu 24.04.
## Screenshots
## Donation
Toss a coin to your developer?
**GitHub Sponsors (Recommended - 100% of your support goes to the developer):**
https://github.com/sponsors/tranxuanthang
**Buy Me a Coffee:**
https://www.buymeacoffee.com/thangtran
**Paypal:**
https://paypal.me/tranxuanthang98
**Monero (XMR):**
```
43ZN5qDdGQhPGthFnngD8rjCHYLsEFBcyJjDC1GPZzVxWSfT8R48QCLNGyy6Z9LvatF5j8kSgv23DgJpixJg8bnmMnKm3b7
```
**Litecoin (LTC):**
```
ltc1q7texq5qsp59gclqlwf6asrqmhm98gruvz94a48
```
## Troubleshooting
**Audio cannot be played in Linux (Ubuntu and other distros)**
Try to install `pipewire-alsa` package. For example, in Ubuntu or Debian-based distros:
```
sudo apt install pipewire-alsa
```
**App won't open in Windows 10/11**
If you are using Windows 10 LTSC, or have tried running some scripts to debloat Windows 10 (which will uninstall Microsoft Edge and its webview component), you might have issues as LRCGET depends on WebView2. Reinstalling Microsoft Edge might fix the problem (see issue https://github.com/tranxuanthang/lrcget/issues/45).
**Scrollbar is invisible in Linux (KDE Plasma 5/6)**
The exact cause is still unknown, but it can be fixed by going to System Settings > Appearance > Global Theme > Application Style > Configure GNOME/GTK Application Style... > Change to something other than breeze (Awaita or Default) > Apply (see comment https://github.com/tranxuanthang/lrcget/issues/44#issuecomment-1962998268)
## Contact
If you prefer to contact by email:
[[email protected]](mailto:[email protected])
## TODO
- [x] Choose multiple directories
- [x] Support .ogg format
- [ ] Embedded lyrics option ([temporary alternative](https://github.com/TheRedSpy15/lrcput))
- [x] Optimize performance for loading large music library (https://github.com/tranxuanthang/lrcget/issues/19)
- [ ] Playlist Filter feature
- [ ] Playlist Sort feature
- [x] Playlist Search feature
- [ ] Volume control
- [x] Mark song as instrumental (https://github.com/tranxuanthang/lrcget/issues/36)
## Development
LRCGET is made with [Tauri](https://tauri.app).
To start developing the application, you need to do the [prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites) steps according to your operating system.
For example, you need the following components to start the development in Windows:
- Microsoft Visual Studio C++ Build Tools
- Rust 1.64.0 or higher
- NodeJS v16.18.0 or higher
Start the development window with the following command:
``` shell
cd lrcget
npm install
npm run tauri dev
```
## Building
Start the build process with the following command:
``` shell
cd lrcget
npm install
npm run tauri build
```
Your built binaries are located at:
```
./src-tauri/target/release/
```
For more detailed instruction, follow the [building guide](https://tauri.app/v1/guides/building/) to build the application according to your OS platform.