Installation

This page explains how to get and install Karaoke Mugené Mugen.

NOTE : Once installed, Karaoke Mugen does not need any internet connection, except for features like url shortener or online accounts.

Download Karaoke Mugen

Binaries for Windows and macOS are available. You'll find either installers or portable installs.

Go to the downloads page

Uncompress the .zip archive in a folder of your choice where there's a lot of disk space available.

Install Karaoke Mugen

There are several ways to install depending on if you want the app from source or from compiled versions ready to use.

Once done, you can go to the getting started section!

Windows

Two choices :

Installer

Double-click on the executable and follow instructions

Portable

Extract the .zip archive in a folder/drive where you have enough space available.

macOS

Image DMG

Double-click on the DMG image and drag & drop Karaoke Mugen in your application folder.

Linux

ArchLinux

There are two AUR packages, karaokemugen and karaokemugen-git. The first is based on the latest stable version and the second on the last commit from the master git branch. They both can be installed in the same way.

Installation
$ pikaur -S karaokemugen-git

Pikaur

Installation can take some time depending on your configuration, from 10 to 20 minutes.

Once done, your console should look like this :

Pikaur end

If you see this, everything went well!

Initial configuration

As you saw, the AUR package comes with the karaokemugen-install utility, allowing you to automatically configure Karaoke Mugen! Launch this utility as soon as install is over.

$ karaokemugen-install

Warning: as said during launch, this script will probably not work if you changed the default PostgreSQL configuration. This script will need super-user rights several times via sudo.

At launch, the script warns you of potential problems which could keep it from working and then does all necessary actions to make Karaoke Mugen work (create database, apply configuration, etc.)

This script is interactive. It may ask you a few questions on what to do (especially if a previous Karaoke Mugen database is found) and other configuration items.

karaokemugen-install

Once done, you're ready to launch Karaoke Mugen.

Launch

Congratulations! Your Karaoke Mugen install is ready to start so you can experience incredible adventures.

You should be able to find Karaoke Mugen in your Applications menu's desktop environment. If that's not the case, launch it simply with karaokemugen in a terminal.

App Launch

Karaoke Mugen

It doesn't work?

First, sorry. We want the install to be as simple as possible but we can't think of everything. Don't hesitate to contact us if you have a problem.

Install from source

You can install Karaoke Mugen by downloading its source code.

  • Download a Karaoke Mugen version from its git repository through git clone or the ZIP archive provided by gitlab.
  • Unzip/place the Karaoke Mugen source code where there's enough free space.
  • Download mpv and place its executable in the app/bin folder or specify its path in the config file if you already have mpv installed on your system.
    • Version 0.25 is the minimum requirement (0.27 for macOS)
    • Version >0.29 under Windows has a problem with progressive karaoke subtitling.
    • Karaoke Mugen installs are bundled with a fixed 0.32 version.
  • Download ffmpeg and place the ffmpeg executable in the app/bin folder.
    • Version 3.3.1 is the minimum requirement
  • Download nodeJS which is required for Karaoke Mugen to run.
    • Minimum version required is 10.9.x.
    • Install nodeJS once it's been downloaded
  • Download PostgreSQL

    • Minimum version required is 10.6. You can try with 9.x versions but it hasn't been battle tested.
    • You'll need to configure your database server for Karaoke Mugen to work. Modify the database.json file to point to your created database. See configuration
    • You need to create the unaccent extension in your Karaoke Mugen database (default is karaokemugen_app). For that connect to the database as superuser and run CREATE EXTENSION unaccent;
  • Open the command line (cmd, terminal, bash...) and go into the Karaoke Mugen folder. Then launch :

If yarn is not installed yet on your system, go to its website to install it.

Once yarn is installed :

yarn setup

yarn will install all necessary modules for Karaoke Mugen to work and build the React client. It can take from 1 to 5 minutes depending on your system's speed and your internet connection.

Platform-specific information

Windows

mpv

If you use your own mpv video player, note that versions above 0.29 have an issue with karaoke subtitles that we use, which makes timings a bit off. More precisely, it's about the progressive karaoke tag \kf.

We supply a custom built mpv with Karaoke Mugen that embeds a fixed libass.

Linux

You'll need PostgreSQL installed and ready to use. Refer to the installation from sources section

Linux (Ubuntu)

The version of mpv provided by the Ubuntu repositories is obsolete, and not compatible with Karaoke Mugen.

You must thus install another version. mpv's official site provides several ways to install Karaoke Mugen, but the simplest is for Ubuntu and its derivatives to use the following PPA :

sudo add-apt-repository ppa:mc3man/mpv-tests
sudo apt-get update
sudo apt-get install mpv

Check out mpv's website for more info.

macOS

Security

If you use macOS Catalina you'll need to disable SIP/Gatekeeper in order to run Karaoke Mugen properly.

mpv

The required mpv version for macOS is 0.25, but to make fullscreen work better, you'll need version 0.27. Install it through your preferred method (macPorts, Homebrew, binaries, etc.)

Raspberry Pi

A version for Raspberry Pi is available through the Mugen Pi Project