|
1 | 1 | # Karaoke Forever
|
2 | 2 |
|
3 |
| -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](https://en.wikipedia.org/wiki/MP3%2BG) and MP4 video files. The server runs on your local network (see [Karaoke Forever Server](https://www.karaoke-forever.com/docs/#karaoke-forever-server)) with no internet connection required. |
| 3 | +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 runs locally, no internet connection required. |
4 | 4 |
|
5 |
| -Karaoke Forever basically has 3 parts: |
6 |
| - |
7 |
| -- **[Server:](https://www.karaoke-forever.com/docs/#karaoke-forever-server)** Runs on Mac/Windows/Linux/etc. to serve the app and media files on your local network. |
8 |
| - |
9 |
| -- **[Mobile browser app:](https://www.karaoke-forever.com/docs/#karaoke-forever)** Everyone can quickly join and queue songs without having to install anything. |
10 |
| - |
11 |
| -- **[Player:](https://www.karaoke-forever.com/docs/#player-admin-only)** Just another part of the browser app, but designed to run in fullscreen mode on the system handling audio and video for a [room](https://www.karaoke-forever.com/docs/#rooms-admin-only). |
12 |
| - |
13 |
| -[](https://www.karaoke-forever.com/static/karaoke-forever-demo1-540p.mp4) |
| 5 | +[](/docs/assets/images/README.jpg?raw=true) |
14 | 6 |
|
15 | 7 | <p align="center">
|
16 |
| - <i>App running in Mobile Safari (left) and Firefox/Chrome/Edge (right)</i><br> |
17 |
| - Watch demo video in |
18 |
| - <a href="https://www.karaoke-forever.com/static/karaoke-forever-demo1-540p.mp4">540p</a> | |
19 |
| - <a href="https://www.karaoke-forever.com/static/karaoke-forever-demo1-720p.mp4">720p</a> | |
20 |
| - <a href="https://www.karaoke-forever.com/static/karaoke-forever-demo1-1080p.mp4">1080p</a> |
| 8 | + <i>App in mobile browser (top) controlling player in Firefox/Chrome (bottom)</i> |
21 | 9 | </p>
|
22 | 10 |
|
| 11 | +Karaoke Forever basically has 3 parts: |
| 12 | + |
| 13 | +- **[Server:](https://www.karaoke-forever.com/docs/#karaoke-forever-server)** Runs on almost any OS to serve the app and your media files |
| 14 | +- **[App:](https://www.karaoke-forever.com/docs/#karaoke-forever-the-web-app)** Fast, modern browser app designed for "karaoke conditions" |
| 15 | +- **[Player:](https://www.karaoke-forever.com/docs/#player)** Just another part of the app, designed to run fullscreen on the system handling audio/video for a [room](https://www.karaoke-forever.com/docs/#rooms-admin-only) |
| 16 | + |
23 | 17 | ## Features
|
24 | 18 |
|
25 |
| -- Modern browser-based app and player with dark UI designed for "karaoke conditions" |
26 |
| -- [MP3+G](https://en.wikipedia.org/wiki/MP3%2BG) and MP4 video file support |
27 |
| -- Milkdrop visualizations via [Butterchurn](https://github.com/jberg/butterchurn) (requires [WebGL 2](https://caniuse.com/#feat=webgl2)) |
28 |
| -- Prioritizes singers based on the amount of time since each last sang |
29 |
| -- Multiple simultaneous rooms/queues/players |
| 19 | +- [MP3+G](https://en.wikipedia.org/wiki/MP3%2BG) and MP4 video support |
| 20 | +- [MilkDrop](https://en.wikipedia.org/wiki/MilkDrop)-style visualizations via [Butterchurn](https://github.com/jberg/butterchurn) (requires WebGL 2) |
| 21 | +- [ReplayGain](https://en.wikipedia.org/wiki/ReplayGain) volume normalization support |
| 22 | +- Singers prioritized by time since each last sang |
| 23 | +- Multiple simultaneous rooms/queues (optionally password-protected) |
30 | 24 | - No telemetry; all data stored locally
|
31 | 25 |
|
32 |
| -Karaoke Forever assumes its player will be mixed with any microphones (either in software or an outboard mixer). See the [F.A.Q.](https://www.karaoke-forever.com/faq/#whats-the-recommended-microphone-audio-setup) for more information. |
| 26 | +Karaoke Forever assumes its player will be mixed with any microphones (either in software or an outboard mixer). See the [F.A.Q.](https://www.karaoke-forever.com/faq#whats-the-recommended-audio-setup) for more information. |
33 | 27 |
|
34 |
| -## Documentation |
| 28 | +## Getting Started |
35 | 29 |
|
36 |
| -Please see [Quick Start](https://www.karaoke-forever.com/docs#quick-start) to get started, or jump to the documentation for [Karaoke Forever](https://www.karaoke-forever.com/docs/#karaoke-forever) (the "web" app) or [Karaoke Forever Server](https://www.karaoke-forever.com/docs/#karaoke-forever-server). |
| 30 | +The [Karaoke Forever website](https://www.karaoke-forever.com/) has a [Quick Start ](https://www.karaoke-forever.com/docs/#quick-start) section as well as the documentation for [Karaoke Forever](https://www.karaoke-forever.com/docs/#karaoke-forever-the-web-app) (the "web" app) and [Karaoke Forever Server](https://www.karaoke-forever.com/docs/#karaoke-forever-server). |
37 | 31 |
|
38 | 32 | ## Discord / Support
|
39 | 33 |
|
40 | 34 | Join the [Karaoke Forever Discord Server](https://discord.gg/PgqVtFq) for general support and development chat, or just to say hi!
|
41 | 35 |
|
42 | 36 | ## Contributing & Development
|
43 | 37 |
|
44 |
| -Contributions are most welcome! Make sure you have [Node.js 12](https://nodejs.org/en/), then: |
| 38 | +Contributions are most welcome! Make sure you have [Node.js](https://nodejs.org/en/) 12 or later, then: |
45 | 39 |
|
46 | 40 | 1. Fork and clone the repo
|
47 | 41 | 2. `npm i`
|
|
0 commit comments