File formats

.kara files

See current documentation on kara files

Version 3

Only compatible with Karaoke Mugen v2.2.0 and higher

The following has been MODIFIED in this version :

Version 2

Only compatible with Karaoke Mugen v2.0.1 and higher

The following has been added in this version :

Version 1

Version 1 is only compatible with Karaoké Mugen v2.0.1 and higher.

Version 0

Version 0 is only compatible with Karaoké Mugen v2.0.0 and lower.

The following info was previously decided from the .kara filename :

.kmplaylist files

Version 4

Added title and series to the list of elements exported. These are not imported back and are only used for human readability

Version 3

Added pseudo_add, created_at, pos, and username to the list of elements exported/imported.

Sample

{
    "Header": {
        "version": 3,
        "description": "Karaoke Mugen Playlist File"
    },
    "PlaylistInformation": {
        "name": "Test import",
        "time_left": 0,
        "created_at": 1519060424.941,
        "modified_at": 1519749130.034,
        "flag_visible": 1
    },
    "PlaylistContents": [
        {
            "kid": "f59fc5f1-bc7a-42a8-b610-337275fbfd63",
            "pseudo_add": "Dummy Plug System",
            "created_at": 1519736989.544,
            "pos": 1,
            "username": "admin"
        },
        {
            "kid": "57595ba8-4eed-4078-990e-4f0fa3d4439a",
            "pseudo_add": "Dummy Plug System",
            "created_at": 1519737017.409,
            "pos": 2,
            "username": "admin"
        },
        {
            "kid": "3f0b8318-eef2-4dbd-9ff6-9b59fffccf70",
            "pseudo_add": "Dummy Plug System",
            "created_at": 1519737240.959,
            "pos": 3,
            "username": "axel"
        },
        {
            "kid": "c747609b-0fd0-468a-9317-eb8de419f615",
            "pseudo_add": "Dummy Plug System",
            "created_at": 1519738409.783,
            "pos": 4,
            "username": "admin",
    "flag_playing": 1
        },
        {
            "kid": "be4fa49e-35b8-4830-a3c6-0811cbc8e91a",
            "pseudo_add": "Dummy Plug System",
            "created_at": 1519749130.022,
            "pos": 5,
            "username": "admin"
        }
    ]
}

Version 2

File is simple JSON with contents described as KID. If everyone uses the same database, KIDs should be consistent through Karaoke Mugen instances, and exporting a playlist on one computer and importing it on another should give back the same results via the KIDs inside.

Sample

{
 "Header": {
     "description": "Karaoke Mugen Playlist File",
     "version": 2
 },
 "PlaylistContents": [
     {
       "flag_playing": 1,
       "kid": "b0de301c-5756-49fb-b019-85a99a66586b"
     },
     {
       "kid": "6da96a7d-7159-4ea7-a5ee-1d78a6eb44dd"
     },
     {
       "kid": "5af7ba4c-2325-451d-a24f-e7fd7c2d3ba8"
     },
     {
       "kid": "e0206f48-0f51-44e3-bf9a-b651916d0c05"
     }
 ],
 "PlaylistInformation": {
     "created_at": 1508936812,
     "flag_visible": 0,
     "modified_at": 1508936821,
     "name": "Test",
     "time_left": 0
 }
}

series.json file

Contains information about series.

Version 3

Compatible with Karaoke Mugen 2.4 and up.

Added a UUID called sid (series ID) to the series object.

Version 2

Same as version 1 but exploded into several files, one per series. Version 2 has never been used in production and is deprecated.

Version 1

This version is compatible with Karaoke Mugen 2.3.2 and below.

JSON file with two objects:

{
      "aliases": [
        "Sangatsu no Lion"
      ],
      "name": "3-gatsu no Lion",
      "i18n": {
        "jpn": "3-gatsu no Lion",
        "eng": "March comes in like a lion"
      }
}