PyKS (short for Python Karaoke Server) is a free and open source cross platform CD+G/MP3 karaoke player. Not only is PyKS a full fledged karaoke player, but it also contains a web interface allowing anyone connected to your network to easily view your songbook, search for songs, and add songs to the queue through their mobile device!
PyKS is written in Python3 and requires the Python 3.5+ interpreter to be installed.
PyKS makes extensive use of PyQt5 and NumPy. Installation instructions can be found on their respective websites.
Alternatively, both PyQt5 and NumPy can be installed through the pip package manager.
pip3 install pyqt5
and
pip3 install numpy
PyKS utilizes the QtMultimedia module which requires the separate installation
of the libqt5multimedia5-plugins package.
sudo apt-get install libqt5multimedia5-plugins
- Download or clone this repository.
git clone https://github.com/tschen/PyKS.git
- Run PyKS from the command line
python pyks.py
See the user guide for more info on how to set up PyKS.
Here are some images of PyKS highlighting a few of its features.
Search the songbook and view the current playlist
Open multiple lyrics windows for multiple external displays
View and select songs from the web app
Control the karaoke player from the web app
- Tim Chen - [email protected]
This project is licensed under GPLv3 - see the LICENSE file for details.
- Jim Bumgardner and his guide on the CD+G specification, CD+G Revealed: Playing back Karaoke tracks in Software
- The creators of PyKaraoke which influenced many aspects of PyKS.