Usage

Karaoke Mugen is a karaoke management software.

Its main purpose is to provide to you and your guests a way to create a playlist and sing on top of it.

How it works

To sum it up

  • The app builds a database with the karaoke files present in its data folder (app/data by default)
  • A webserver is started on your computer: it allows your users to connect to it with their device and search through your karaoke database. It also allows them to add those they want to sing on. Two modes are available, private or public. Your users have to be on your Wifi network.
  • The admin, or DJ depending on how you want to call it, can manage the video player, pause, play, modify the playlist or change the karaoke configuration from another interface only available through its login/password
  • The world is saved!

Let's see how you can setup your first karaoke session.

Starting up

Binary download

Double-click on the Karaoke Mugen executable file on Windows or macOS and voilĂ !

Source download

You can start Karaoke Mugen through the command line / terminal. Go to the Karaoke Mugen folder and start the app with :

yarn setup
yarn start

First launch

Here's what you should see :

Initialisation

We can see the software initializes its components. In this example, as it doesn't find any karaoke database, it will create one from your app/repos folder and what it contains.

Database generation can be real quick if you don't have many songs, but with more than 8000 karaokes, it can take a few minutes, but that's not something you'll do very often. Depending on where the files are (SSD, HDD, or network share) it can take more or less time.

A series of questions will be asked to see if you want to create an online or local account. An online account can be used on all Karaoke Mugen apps (if you go to someone else's place to do some karaoke, for example, or on kara.moe.)

Follow instructions on screen and everything should be fine.

Screen accueil

Once on the welcome screen, the app will try to update its various data from the internet, and ask you if you want to send us stats and other error tracking information.

From this welcome screen, you can then launch the tutorial, the operator or public interface, or configure the app, download songs and check out what's new, as well as the event log.

Databases

Let's talk a little about databases before continuing.

Karaoke Mugen stores its data in a PostgreSQL database you can find in app/db/postgres

The binary versions of Karaoke Mugen include a PostgreSQL server which is launched on startup so you don't have to worry about anything. You can still use your own PostgreSQL server if you'd like. You'll find more info in the configuration section.

When updating Karaoke Mugen, databases are updated as well without you having to worry about it.

First steps

Another window should also appear in the lower left corner of your screen with a wallpaper and connection info.

Background

The URL at the bottom will allow your users to connect to the karaoke selection interface. This is https://kara.moe. Only people on your local Wifi network are able to go there.

For those not connected to the internet, your local IP address will be displayed instead.

By default, Karaoke Mugen is configured in PIP (Picture in Picture) mode. The video player will play your karaokes in a small window so you can test things out. To get it to go full screen, you'll need to configure the app.

This PIP mode is perfect for tests or to have some background music while you work on something else. To get it to go full screen manually, you can :

  • Double click inside.
  • Click on the window and press the F key
  • Change the option in the Karaoke Mugen interface

Video player

The video player used is mpv, which you can find on its website, mpv.io.

Here are some useful key shortcuts :

  • ESC : Leave fullscreen
  • Q : Exit player (this does not exit Karaok Mugen!)
  • Left/Right arrow : Forward/Rewind in a video
  • Up/Down arrow : Forward/Rewind faster in a video
  • F : Switch between fullscreen and windowed mode. Karaoke Mugen keeps the player open between two songs, this setting will thus stay as long as you don't quit the app. The player will in windowed mode again on next startup unless you go change the setting itself.
  • Mouse wheel up/down : Change volume (Mouse cursor must be over the window)

These keys only work if you have "focus" on the video player. Click inside the window to get focus.

You can also move the window around on your screen. By default it is always on top, but this can be changed.

Karaoke database

Downlod songs

On its first launch, Karaoke Mugen, if it finds no songs, will ask you if you'd like to download a few of them at random from Karaoke Mugen Server

You can then download the songs you want from the system panel, or from the "Download" button on the welcome screen.

Download

You can also download all the songs available from the community.

Download_All

WARNING : Video take at least a few hundred gigabytes, so make sure you have enough space available.

You can quit Karaoke Mugen at any time and it will resume your downloads on next start.

That said, you might not want to get everything at once, but only the songs you want. To achieve that, you can select and filter only the songs you want.

There's the search box, of course, but also a sort filter on the right, which can help you display only songs with a specific tag. For example, if you want to get all songs in a particular language, you should go to the "Tag filter" box and click on "Languages" then on the language you want so you can select one to filter songs.

Download_Bre

A simple search with your language's name would have worked as well.

Once the list displayed is the one you want, you can either download the songs of your choice or click on the button on the top right to download all songs listed.

Download

Create your own base

This is for advanced users.

You can create your own karaoke base, go to the system panel. You can add songs manually if you already have videos and .ass files of your own.

Update your karaoke base

  • Use the system panel just like described above, simply click on "Synchronize" to fetch all updates of all configured repositories at once.
  • You can also launch Karaoke Mugen via its command line with the --updateBase option flag.

Repositories

Repositories are places where you can download songs. By default the OTAKU base is added to your Karaoke Mugen application, but other communities can create their own repositories which you can add so your app knows where to download new songs from.

Interfaces

Karaoke Mugen has several interfaces depending on what you want to do.

You can switch from one to the other via the "Go to" menu on the application window or from the welcome screen.

Public interface

This is the interface for your guests/public. It allows them to search for songs, see playlists, and add songs to the public playlist. It won't allow you to control the player or manage your karaoke session.

Go to the URL displayed on the video player's wallpaper.You'll get to see this :

Public interface example

Operator interface

You can connect to it from the application's main window.

Apart from using the app's window, you can reach it using the following URL from your machine or another one : http://<your_ip>:1337/admin. Check out the player's wallpaper to get your IP address.

You can easily manage the player from the admin panel and your various playlists. You can see here that we have a list of all the available songs on the left, and our current playlist on the right.

Try to add karaokes in the current playlist and click on Play!

Admin interface example

System panel

From this interface you can :

  • Configure karaoke sessions
  • Read logs
  • Configure advanced options
  • Create and remove users
  • Create and edit songs
  • Create and edit various song metadatas
  • Update your karaokes
  • Download new songs
  • And many other things!

Using the application

Playlists

You can create as many playlists as you want. these lists can be useful to prepare for karaoke sessions and parties, or listen to various songs depending on your mood.

A playlist can have as many songs as you want, but a song can only be present once in a list.

A playlist can have several attributes. The default playlist has both the current and public flags :

Public playlist

A public playlist is a suggestions list. It's mainly used in the public karaoke mode (see below). If you use the private mode (default) you don't need to bother with it.

Only one list can have the public flag.

Current playlist

A current playlist is the one used by the video player.

Only one list can have the current flag.

Current AND public playlist

The default playlist has both flags, which means your guests can add songs which will be directly used by the video player.

However, if you have two separate lists, one public and one current, you can filter suggestions from your guests before sending them to the video player!

Blacklist

Karaoke Mugen has a blacklist system with criterias.

Songs in the blacklist won't appear anymore in the karaoke list users can see. Admins can still see them though.

You can add songs directly to the blacklist, but you can also define criterias to automatically add a set of songs. Once they are defined, Karaoke Mugen will generate a new blacklist for you.ous.

Criterias are :

  • Karaoke : Adds a unique song
  • Titre contains : Title contains the specified word (example "Gundam").
  • Longer/shorter than : All songs longer or shorter than the specified value (in seconds) will be blacklisted. Useful for AMVs or long songs.
  • Tags : Ban by specific tag (as opposed to ban if tag contains a word).
  • Singer
  • Type : Ban by type (Opening, Ending, Clip, AMV, etc.).
  • Creator
  • Kara author : Ban by the name of the karaoke author
  • Language : Ban by language
  • Misc : Ban by misc tag (Concert, Video game, R18, etc.).
  • Songwriter : Ban by songwriter

Here are some ideas of things you can ban : songs longer than four minutes, those with the Spoiler or adults Only tags, etc.

All songs present in the whitelist are ignored when generated the blacklist.

You can save several criterias set and switch them on the fly depending on what you want to ban and when. You might want to ban some specific things during a wedding but not during a party with friends.

Whitelist

You can add songs to this list. These won't be taken into account when generating the blacklist. For example you might want to ban all mecha anime but keep King Gainer.

Favorites

Every user has a favorites list in which the admin can pick songs they'd like to add to the current playlist if needed.

You can add songs to your favorites either by clicking on the wrench icon in the operator interface or by displaying song details in the public interface.

AutoMix lists

Admins can create special playlists called AutoMix. These are made from all favorites from logged in users.

Public vote

Want to let the public choose their songs? Public vote can be enabled in the admin interface and allows users to vote for songs they wish to be added next. The public interface will display a window asking users to vote for the song they'd like. Songs are selected from the public playlist.

If no song is the clear winner, a random song will be chosen amonog the ones with the most votes.

This is an ideal mode if you don't want to bother with choosing songs.

Likes

When checking out the public playlist, users can like a particular song to tell the admin they'd like to see it play soon. This allows the admin to get a better idea of which songs are more popular.

As every user has a limited number of songs they can add during a karaoke session, if the song it requested (the first Naruto opening for example) gets liked enough, it won't count anymore in the user's quota. The user who requested the song can then request another song freely without having to wait for the opening to be played on screen. This free song mechanic can be entirely configured.

Admins can free songs manually so users can regain quota.

Users

Every user can now have an account in the app. This account is local and bound to your karaoke instance. It contains a profile and the list of your favorite songs.

Online accounts are recognizable with the @ in their name. For example axel@kara.moe. The right-most part works like a mail address and identifies the Karaoke Mugen Server the compte is located at.

If you don't wish to create an account, you can click on "Continue as guest" so Karaoke Mugen can assign a guest account to you.

Guests cannot change their names and don't have a favorites list. They also can't like songs.

If you have a local account on your Karaoke Mugen, you can convert it to an online account from your profile.

You can also convert your account online to a local account: this will remove any possibility of connecting with another instance and will delete your account from Karaoke Mugen Server (kara.moe)

kara.moe is made available to Karaoke Mugen users, but you can open your own Karaoke Mugen server to offer online accounts and a shortened URL of your choice (as long as you have the domain name)

Sessions

Sessions are karaoke moments. Parties, birthdays, events... Each session contains played and requested songs during it and can be helpful to make statistics, rankings, etc.

You can select the active session from the welcome screen.

You can also modify sessions from the system panel.

A session with the "private" flag won't be sent to Karaoke Mugen Server for stats.

Song request quota

With its default config, Karaoke Mugen allows everyone to add 10 000 songs to the playlist. Obviously this limit can be changed by the karaoke operator in the options panel. Your song quota is displayed at the bottom of the screen.

  • When you add a song, your quota loses one point.
  • When your song is played, your quota gets back that point.
  • If the song is sufficiently liked then it'll be freed.
  • The song will also automatically be freed after a set period of time if it hasn't been played yet.

Quota can also be based on song time to avoid people adding long songs too often.

Restrict interface

By default the public interface is open: everyone can use all its features. However, when your karaoke nears its end, it could be interesting to restrict or close the interface to avoid people adding any new songs.

Three modes are available:

  • Open: Users can add songs to the playlist
  • Restricted: Users can only see the current song and the current playlist.
  • Closed: well... closed. Nothing is possible.

Adding mystery songs

The operator can decide if what people add is visible or not in the playlist. Invisible songs count in the playlist but are displayed with a configurable name (by default ???)

It's great to create surprises for your guests, or simply to simply to make your playlist feel all mysterious.

The operator can make sure all the songs he/she adds are considered mystery songs.