Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/osdlyrics/osdlyrics

Standalone lyrics fetcher/displayer (windowed and OSD mode).
https://github.com/osdlyrics/osdlyrics

gtk hacktoberfest linux lrc lyrics osd

Last synced: about 2 months ago
JSON representation

Standalone lyrics fetcher/displayer (windowed and OSD mode).

Host: GitHub
URL: https://github.com/osdlyrics/osdlyrics
Owner: osdlyrics
License: gpl-3.0
Fork: true (tigersoldier/osd-lyrics)
Created: 2011-07-10T14:17:44.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2023-12-20T14:11:28.000Z (12 months ago)
Last Synced: 2024-03-26T02:23:45.253Z (9 months ago)
Topics: gtk, hacktoberfest, linux, lrc, lyrics, osd
Language: C
Homepage: https://twitter.com/OSDLyrics
Size: 4.11 MB
Stars: 319
Watchers: 25
Forks: 53
Open Issues: 31
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

fucking-Awesome-Linux-Software - ![Open-Source Software - Show lyrics with your favorite media player. (Applications / Audio)
Awesome-Linux-Software - ![Open-Source Software - Show lyrics with your favorite media player. (Applications / Audio)

README

# OSD Lyrics

Show synced lyrics with your favorite media player on Linux.

## Introduction

OSD Lyrics is a desktop application to view lyrics compatible with various media players. It is not a plugin but a standalone program. OSD Lyrics shows lyrics on your desktop, in the style similar to KaraOK. It also provides another displaying style, in which lyrics scroll from bottom to top. OSD Lyrics can download lyrics from the network automatically.

![Screenshot in OSD mode](screenshot.png)

## License

OSD Lyrics is released under GPL v3. See [LICENSE](LICENSE) for more detail.

## How to use

To use OSD Lyrics, just launch your media player, then launch OSD Lyrics.
OSD Lyrics will detect and connect to the media player.

## How to install

OSD Lyrics is available for Ubuntu, Debian, Fedora, OpenSUSE, FreeBSD and ArchLinux.
A list of packages' names, versions, and install instructions for each distribution is [available at pkgs.org](https://pkgs.org/search/?q=osdlyrics).

## Build instructions

### Requirements

* On Ubuntu, dependencies are listed on the [Ubuntu Universe page](https://packages.ubuntu.com/source/focal/osdlyrics).
* On Debian, dependencies are listed on the [Sid packages' page](https://packages.debian.org/sid/osdlyrics).
* On ArchLinux, dependencies are listed on the [AUR package](https://aur.archlinux.org/packages/osdlyrics-git).

## Cloning repository

You can use git to clone our repository with the latest changes, use the following command:

```
git clone https://github.com/osdlyrics/osdlyrics.git
```

## Building

After cloning the repository and installing dependencies, issue the following commands at the cloned directory to build and install:

```
./autogen.sh
./configure --prefix=/usr PYTHON=/usr/bin/python3
make
sudo make install
```

You can read more at [Building wiki page](https://github.com/osdlyrics/osdlyrics/wiki/Building).

Since version `0.5.15` Python 2 is no longer supported. Please upgrade to Python 3.12+.

## Troubleshooting

Check [Troubleshooting wiki page](https://github.com/osdlyrics/osdlyrics/wiki/Troubleshooting) for more detailed help.

## Contact us

The official source repository is on Github: https://github.com/osdlyrics/osdlyrics

If there is any feature request, suggestion, or bug, feel free to report them in [issues page](https://github.com/osdlyrics/osdlyrics/issues).

You can contact the developers for fast support through [our Discord server](https://discord.gg/vHC2Q3YUuA).

## How to contribute

We adopt [GitHub flow](https://guides.github.com/introduction/flow/index.html) for development, this means you can use GitHub issues, projects and pull requests pages to respectively submit bugs/suggestions, take a look at current roadmap/Kanban and submit changes.

You can read more at [Contributing wiki page](https://github.com/osdlyrics/osdlyrics/wiki/Contributing).

## Acknowledgements

Thanks to all the people who have directly or indirectly helped in the development of this project.
Special thanks to the original author "[Tiger Soldier](mailto:[email protected])", first contributors "[Sarlmol Apple](mailto:[email protected])", "[Simply Zhao](mailto:[email protected])" and everybody else listed at [contributors page](https://github.com/osdlyrics/osdlyrics/graphs/contributors).