This is the git repository for the Karaoke Mugen karaoke database. It is to be used with the software found at the site linked just now, but you can also use it freely for your own purposes. See our license for more information.
A karaoke is made of the following elements :
- A
.kara.jsonfile in thekaraokesfolder - A
.assfile in thelyricsfolder - A video or audio file in the
mediasfolder - One or more
.tag.jsonfiles in thetagsfolder
Optionally .hook.yml files in the hooks folder for tag automation when creating/editing songs in the app
This folder holds files with karaoke metadata such as video file, lyrics file, etc. It uses the standard JSON format.
This folder contains the subtitles files as specified in the .kara.json file.
It is generally a .ass file made with Aegisub. See the contribution guide for a more detailed tutorial on how to write good karaokes.
This contains optional fonts that many ASS files might use in the repository. This will be copied by KM at startup for the player to use.
This folder contains the video or audio file as specified in the .kara.json file.
Videos aren't included in this git repository or else it'd be way too huge (about several hundred gigabytes at the moment). KM will take care of these for you.
If you get errors from Karaoke Mugen during database generation / validation, make sure you have the latest version of the repository (git pull or downloaded the latest master.zip).
A song has many tags defining its metadata, like singers, songwriters, creators, genres, etc. These are used by the search engine.
See the contribution guide for more information on how you can help.
More or less, yes. See the license for more details.