Git Product home page Git Product logo

cjr-karaoke-eternal's Introduction

Karaoke Eternal

Host awesome karaoke parties where everyone can easily find and queue songs from their phone's browser. The player is also fully browser-based with support for MP3+G, MP4 videos and WebGL visualizations. The server is self-hosted and runs on nearly everything.

Karaoke Eternal

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

Features

  • Supports:
    • MP3+G with Winamp/MilkDrop visualizations (WebGL 2)
    • MP4 videos
    • ReplayGain tags for volume normalization
  • Fast, modern mobile browser app designed for "karaoke conditions"
  • Multiple simultaneous rooms/queues (optionally password-protected)
  • Dynamic queues keep parties fair, fun and no-fuss
  • Fully self-hosted
  • No ads or telemetry

Microphones are not required since the player itself only outputs music - this allows your audio setup to be as simple or complex as you like. See the F.A.Q. for more information.

Getting Started

Karaoke Eternal basically has 3 parts. See Getting Started to get up and running step-by-step, or jump to the documentation for each part below:

  • Server: Runs on pretty much anything to serve the web app and your media files, including a Windows PC, Mac, or a dedicated server like a Raspberry Pi or Synology NAS.
  • App: Fast, modern mobile web app designed for "karaoke conditions".
  • Player: Just another part of the app, but meant to run fullscreen on the system handling audio/video for a room

Installation

There are several installation methods available for Karaoke Eternal Server.

Discord & Support

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

Contributing & Development

Contributions are welcome! Please join the #dev channel of the Discord Server before embarking on major features; the project's scope is limited to ensure success.

Make sure you have Node.js 16 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

cjr-karaoke-eternal's People

Contributors

bhj avatar justingreenberg avatar neverfox avatar dougvk avatar simonselg avatar stevenlangbroek avatar rsilvestre avatar patrickheeney avatar dependabot[bot] avatar anthonyraymond avatar iamstarkov avatar timtyrrell avatar spencercdixon avatar nodkz avatar nathanielks avatar mistereo avatar inooid avatar mmermerkaya avatar abbviemr avatar ipanasenko avatar vkvelho avatar werelax avatar davidgtonge avatar davecarlson avatar apaatsio avatar andreirailean avatar nuragic avatar shahul3d avatar mealeyst avatar nrbunn avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.