Karol-Oke

A simple and easy-to-use Music Player for your karaoke parties! Play videos with synchronized lyrics and have fun with your friends.

Quick Start

Download Pre-built Executable (Recommended)

Download the latest release for your platform from GitHub Releases:

Linux:

chmod +x karoloke-v*-linux
./karoloke-v*-linux

macOS:

chmod +x karoloke-v*-macos
./karoloke-v*-macos

Windows: Double-click karoloke-v*-windows.exe to run.

Installation from Source

• Requires Python 3.9+
• Install via pip:

  pip install karoloke
  

Usage

• Start the application:

  karoloke
  

• The server will start locally and open in your default browser
• Configure your video directory by clicking the settings button (top-right corner)
• Supported formats: .mp4, .webm, .ogg
• Select a song number and press Enter to start playing
• The video player is responsive and works on all screen sizes

Troubleshooting

Windows

Antivirus False Positive: If Windows Defender or your antivirus flags the executable:

1. Click "More info" in the SmartScreen warning
2. Click "Run anyway"
3. Alternatively, add an exclusion for the karoloke executable in Windows Security

macOS

Gatekeeper Warning (Unsigned Executable): If you see "cannot be opened because the developer cannot be verified":

1. Right-click the executable file
2. Select "Open" from the context menu
3. Click "Open" in the dialog
4. The app will now be allowed to run

Alternatively, use Terminal:

xattr -d com.apple.quarantine karoloke-v*-macos

Linux

GLIBC Compatibility: The executable is built on Ubuntu and requires GLIBC 2.31+. If you encounter errors:

./karoloke-v*-linux: /lib/x86_64-linux-gnu/libc.so.6: version 'GLIBC_2.XX' not found

Solution: Install from source using pip or use a newer Linux distribution.

Permission Denied: Make sure the file is executable:

chmod +x karoloke-v*-linux

Documentation

Full documentation is available at ReadTheDocs.

Contributors

Thank you all the special people that invested their time and knowledge to improve this project. 👏