File formats

.kara files

See current documentation on kara files

Version 4

Compatible with Karaoke Mugen 3.0.0 and above.

Self-explanatory JSON example :

{
  "header": {
    "version": 4,
    "description": "Karaoke Mugen Karaoke Data File"
  },
  "medias": [
    {
      "version": "Default",
      "filename": "ENG - Portal 2 - PC GAME ED - Want You Gone.mp4",
      "audiogain": 1.93,
      "filesize": 30578533,
      "duration": 145,
      "default": true,
      "lyrics": [
        {
          "filename": "ENG - Portal 2 - PC GAME ED - Want You Gone.ass",
          "default": true,
          "version": "Default",
          "subchecksum": "cc116b584fb9097b8246369c45e4f733"
        }
      ]
    }
  ],
  "data": {
    "created_at": "Wed Oct 11 2017 19:01:47 GMT+0200 (GMT+02:00)",
    "kid": "c237d00a-3dd2-4884-9a68-8c0638734dd4",
    "modified_at": "Sun Jul 29 2018 15:12:56 GMT+0200 (GMT+02:00)",
    "repository": "kara.moe",
    "sids": [
      "a7e45824-e4b8-415f-a0ee-125ba7f43a9c"
    ],
    "title": "Want You Gone",
    "platforms": [
      "3c15f758-e1bc-4266-8bb9-3c14112f504a"
    ],
    "tags": {
      "authors": [
        "5bdaba57-27f8-4568-8806-76a807728766"
      ],
      "creators": [
        "4b4e7060-c4a2-42db-bc76-871d266b41fc"
      ],
      "families": [
        "dbedd6b3-d125-4cd8-aa32-c4175e4ca3a3"
      ],
      "groups": [
        "ae613721-1fbe-480d-ba6b-d6d0702b184d",
        "9c79e1bb-a5b9-4059-ad20-4687ec733371"
      ],
      "langs": [
        "de5eda1c-5fb3-46a6-9606-d4554fc5a1d6"
      ],
      "platforms": [
        "3c15f758-e1bc-4266-8bb9-3c14112f504a"
      ],
      "singers": [
        "48c64b08-3394-41c1-a804-a2f26824330e"
      ],
      "songtypes": [
        "38c77c56-2b95-4040-b676-0994a8cb0597"
      ],
      "songwriters": [
        "7658bb92-03da-4d66-905f-8d6b866e4459"
      ]
    },
    "year": 2011
  }
}

Version 3

Only compatible with Karaoke Mugen v2.2.0 and higher

The following has been MODIFIED in this version :

  • videofile becomes mediafile
  • videogain becomes mediagain
  • videosize becomes mediasize
  • videoduration becomes mediaduration

Version 2

Only compatible with Karaoke Mugen v2.0.1 to v2.2.0

The following has been added in this version :

  • subchecksum

Version 1

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

Version 0

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

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

  • title
  • series
  • order
  • type

.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

created_at and modified_at fields are now in JS Date format.

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.1

Compatible with Karaoke Mugen 3.0 and up.

Added a tag property containing array of tag IDs (TIDs) the series is linked to, like the franchises property which lists franchises the series is from

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:

  • header contains version and description properties.
  • series is an array of series objects described as follows :
{
      "aliases": [
        "Sangatsu no Lion"
      ],
      "name": "3-gatsu no Lion",
      "i18n": {
        "jpn": "3-gatsu no Lion",
        "eng": "March comes in like a lion"
      }
}
  • alias is an array of text aliases used for the search engine
  • name is the name of the series, which identifies it with the series= parameter of .kara files.
  • i18n is an object where each property is a ISO639-2B language code and its corresponding name in that language.