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 database 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 :

  • karas : All the .kara.json files, which are metadata about your karaoke songs.
  • lyrics : All the .ass files, which are subtitles and the actual karaoke files.
  • tags : All the .tag.json files, which are metadata about tags used in your kara files.
  • hooks : (Optional) All automations for karaoke creation
  • medias : All the medias (.mkv/avi/webm/mp4/mp3/ogg…) used for karaoke.

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

app
  - repos
    - kara.moe
      - json
        - karaokes
        - lyrics
        - tags
        - hooks
      - medias

These folders are configurable in the config.yml file or on the Repositories page in the system panel. 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.json 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.json files can be generated from Karaoke Mugen’s system panel.

Database

This database is created from your .kara.json, .tag.json 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 System Panel to start a database generation. A generation will also be triggered if Karaoke Mugen detects any modification at launch.

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

Editing/creating new karaoke files

See the docs to do these.