<commit_before>---
permalink: /docs/index.html
---
# Karaoke Forever

- [Overview](#overview)
- [Quick Start](#quick-start)
- [Karaoke Forever](#karaoke-forever-the-web-app) (the web app)
  - [Library](#library)
  - [Queue](#queue)
  - [Account](#account)
    - [Rooms](#rooms) (admin only)
    - [Preferences](#preferences) (admin only)
    - [My Account](#my-account)
  - [Player](#player) (admin only)
- [Karaoke Forever Server](#karaoke-forever-server)
  - [Installation](#installation)
  - [Supported Media Files](#supported-media-files)
  - [The Meta Parser](#the-meta-parser)
    - [Configuring the Parser](#configuring-the-parser)
    - [Augmenting or Replacing the Parser (Advanced)](#augmenting-or-replacing-the-parser)

## Overview

Host awesome karaoke parties where everyone can find and queue songs from their phone's web browser. Supports [MP3+G](https://en.wikipedia.org/wiki/MP3%2BG) (mp3+cdg) and mp4 video files. No internet connection required.

Karaoke Forever has a few parts:

- **[Server:](#karaoke-forever-server)** Runs on the macOS/Windows/Linux/etc. system with your media files. Serves the web app on your local network.

- **[Web app:](#karaoke-forever-the-web-app)** Designed from the ground up for mobile browsers, anyone can easily join using their phone.

- **[Player:](#player-admin-only)** Runs fullscreen in a browser on the system handling audio/video for the room.

**Note:** Karaoke Forever does not handle audio *input* since there are a wide variety of possible audio interface and microphone configurations. It is assumed that the Player's output will be mixed with the microphone input(s) by the system.

## Quick Start

1. Install and run Karaoke Forever Server on the system that will locally serve the media files and web app.

  **Important:** The server app is not currently signed, so macOS and Windows SmartScreen will complain by default. *Do not disable Gatekeeper* on macOS - simply right-click the file and choose Open.

2. Click the Karaoke Forever Server menubar icon (macOS) or right-click the tray icon (Windows) to show the server URL. You can click *Open in browser* or browse to the server URL (including port) from any device on the network. The web app is primarily designed for mobile browsers.

3. Enter your user details and click Create Account to create your admin account.
<commit_msg>Fix a few more docs TOC links<commit_after>---
permalink: /docs/index.html
---
# Karaoke Forever

- [Overview](#overview)
- [Quick Start](#quick-start)
- [Karaoke Forever](#karaoke-forever-the-web-app) (the web app)
  - [Library](#library)
  - [Queue](#queue)
  - [Account](#account)
    - [Rooms](#rooms-admin-only) (admin only)
    - [Preferences](#preferences-admin-only) (admin only)
    - [My Account](#my-account)
  - [Player](#player-admin-only) (admin only)
- [Karaoke Forever Server](#karaoke-forever-server)
  - [Installation](#installation)
  - [Supported Media Files](#supported-media-files)
  - [The Meta Parser](#the-meta-parser)
    - [Configuring the Parser](#configuring-the-parser)
    - [Augmenting or Replacing the Parser (Advanced)](#augmenting-or-replacing-the-parser-advanced)

## Overview

Host awesome karaoke parties where everyone can find and queue songs from their phone's web browser. Supports [MP3+G](https://en.wikipedia.org/wiki/MP3%2BG) (mp3+cdg) and mp4 video files. No internet connection required.

Karaoke Forever has a few parts:

- **[Server:](#karaoke-forever-server)** Runs on the macOS/Windows/Linux/etc. system with your media files. Serves the web app on your local network.

- **[Web app:](#karaoke-forever-the-web-app)** Designed from the ground up for mobile browsers, anyone can easily join using their phone.

- **[Player:](#player-admin-only)** Runs fullscreen in a browser on the system handling audio/video for the room.

**Note:** Karaoke Forever does not handle audio *input* since there are a wide variety of possible audio interface and microphone configurations. It is assumed that the Player's output will be mixed with the microphone input(s) by the system.

## Quick Start

1. Install and run Karaoke Forever Server on the system that will locally serve the media files and web app.

  **Important:** The server app is not currently signed, so macOS and Windows SmartScreen will complain by default. *Do not disable Gatekeeper* on macOS - simply right-click the file and choose Open.

2. Click the Karaoke Forever Server menubar icon (macOS) or right-click the tray icon (Windows) to show the server URL. You can click *Open in browser* or browse to the server URL (including port) from any device on the network. The web app is primarily designed for mobile browsers.

3. Enter your user details and click Create Account to create your admin account.

{'fraction_non_alphanumeric': 0.10843120805369127, 'fraction_numerical': 0.003355704697986577, 'mean_word_length': 4.310690423162583, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1158956', 'n_tokens_mistral': 1436, 'n_tokens_neox': 1357, 'n_words': 570}