Karaoke Management

This page describes how karaokes are handled in Karaoke Mugen, how to add, delete or edit them, etc.

First things first

To work, Karaoke Mugen needs karaokes. We'll call that a karaoke base. This is the set of video, lyrics and metadata files you own.

Don't confuse it with the Karaoke Mugen databases which are files generated by the software and store all the important data it needs to run.

What is a karaoke base

To import data and create its databases, Karaoke Mugen needs to know where to find your media, lyrics, and metadata files.

A karaoke base folder has three subfolders which are named by default :

Typically, you'll get a foledr structure like this :

  - data
     - karas
     - lyrics
     - medias

These folders are configurable in the config.ini file. See the configuration section for more details. You can, for example, have videos on an external hard drive or network share to save space.

.kara files

This file stores metadata about your karaoke, it is mandatory : it tells Karaoke Mugen where your subtitle and video files are, as well as other information it needs to generate its database.

.kara files can be generated from Karaoke Mugen's control panel.

For more information on .kara files, see the karaoke repository documentation (in french for now)

karas.sqlite3 database

This database is created from your .kara and media files.

Karaoke Mugen uses it to hold data from your karaoke base to make it searchable.

Once the base is generated, the software only needs to read .ass and media files during runtime.

Generate a database

You can launch Karaoke Mugen with the --generate command line flag or go to the control panel to start a database generation.

This will take a few minutes depending on your computer's speed.

Editing/creating new karaoke files

.kara files

You can go to Karaoke Mugen's control panel to create a new karaoke file. In the karas dropdown menu, select "New karaoke" and fill the form.

A faw things to keep in mind :

Manage series

In the series menu you can manage series. Add, edit, or remove them.

A few things to keep in mind :