Skip to content

mik3y/karaoke-forever

 
 

Repository files navigation

Karaoke Forever

Host awesome karaoke parties where everyone can easily find and queue songs from their phone's web browser. The player is also browser-based with support for MP3+G, MP4 video and WebGL visualizations. The server is self-hosted with no internet connection required.

Karaoke Forever

App in mobile browser (top) controlling player in Firefox/Chrome (bottom)

Features

  • MP3+G and MP4 video support
  • MilkDrop-style visualizations via Butterchurn (requires WebGL 2)
  • ReplayGain volume normalization support
  • Singers prioritized by time since each last sang
  • Multiple simultaneous rooms/queues (optionally password-protected)
  • No ads or telemetry; all data stored locally

Karaoke Forever assumes its player will be mixed with any microphones (either in software or an outboard mixer). See the F.A.Q. for more information.

Download & Install

See Releases available for your OS, as well as the installation documentation.

Please note that the main branch is actively developed and is not guaranteed to be stable.

Getting Started

Karaoke Forever basically has 3 parts. You can jump to the documentation for each below, or Quick Start to get up and running step-by-step.

  • Server: Runs on almost any OS to serve the app and your media files
  • App: Fast, modern mobile browser app designed for "karaoke conditions"
  • Player: Just another part of the app, designed to run fullscreen on the system handling audio/video for a room

Discord / Support

Join the Karaoke Forever Discord Server for general support and development chat, or just to say hi!

Contributing & Development

Contributions are most welcome! Make sure you have Node.js 12 or later, then:

  1. Fork and clone the repo
  2. npm i
  3. npm run dev and look for "Web server running at" for the server URL

Packages

No packages published

Languages

  • JavaScript 91.0%
  • CSS 8.9%
  • HTML 0.1%