README.md 11.2 KB
Newer Older
1
[Version en français plus bas](#French version)
2

3 4
![Badge](https://img.shields.io/github/last-commit/AxelTerizaki/karaokebase.svg)
![Badge](https://img.shields.io/github/tag/AxelTerizaki/karaokebase.svg)
Guillaume Lebigot's avatar
Guillaume Lebigot committed
5
![Badge](https://img.shields.io/github/repo-size/AxelTerizaki/karaokebase.svg) ![Discord](https://img.shields.io/discord/84245347336982528.svg)
6 7

[![Creative Commons](https://img.shields.io/badge/License-Creative%20Commons%204.0%20BY--NC--SA-brightgreen.svg)](http://creativecommons.org/licenses/by-nc-sa/4.0/)
8

9
# English version
10

11 12
## Karaoke Mugen database

13
This is the git repository for the [Karaoke Mugen](http://karaokes.moe) 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](LICENSE.md) for more information.
14 15 16 17 18

## Format

A karaoke is made of the following elements :

Guillaume Lebigot's avatar
Guillaume Lebigot committed
19
* A `.kara.json` file in the `karas` folder
20
* A `.ass` file in the `lyrics` folder
21
* A video or audio file in the `medias` folder
Guillaume Lebigot's avatar
Guillaume Lebigot committed
22
* A `.series.json` file in the `series` folder
Guillaume Lebigot's avatar
Guillaume Lebigot committed
23
* A `.tag.json` series of files in the `tags` folder
24 25 26

### `karas` folder

Guillaume Lebigot's avatar
Guillaume Lebigot committed
27
This folder holds files with karaoke metadata such as video file, lyrics file, etc. It uses the standard JSON format.
28 29

Example :
Guillaume Lebigot's avatar
Guillaume Lebigot committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
```JSON
{
  "header": {
    "version": 4,
    "description": "Karaoke Mugen Karaoke Data File"
  },
  "medias": [
    {
      "version": "Default",
      "filename": "ENG - DAICON IV - MV - Twilight.mp4",
      "audiogain": -5.61,
      "filesize": 62384194,
      "duration": 264,
      "default": true,
      "lyrics": [
        {
          "filename": "ENG - DAICON IV - MV - Twilight.ass",
          "default": true,
          "version": "Default",
          "subchecksum": "365637bcf398feb256f78773c75d81d9"
        }
      ]
    }
  ],
  "data": {
    "created_at": "Wed Oct 11 2017 19:03:04 GMT+0200 (GMT+02:00)",
    "kid": "17d535bd-101b-4ffc-836d-e26774bbb1b5",
    "modified_at": "Fri Mar 15 2019 11:19:17 GMT+0100 (GMT+01:00)",
    "repository": "kara.moe",
    "sids": [
      "987d5e61-0183-4f3f-bd9d-a1bdca12c84c"
    ],
    "tags": {
      "authors": [
        "1df04771-a378-4f14-a5e1-1455187d681a"
      ],
      "creators": [
        "0cf8c590-19cd-413a-902c-fb18f44fc385"
      ],
      "families": [
        "0377db02-3af6-43b8-9b08-c759df3d25c3"
      ],
      "groups": [
        "7792cc27-9ff9-4d47-9287-2338b7db1575",
        "f5e7d2fc-0cbb-4fb9-a84a-b25dfb0e9e77"
      ],
      "langs": [
        "de5eda1c-5fb3-46a6-9606-d4554fc5a1d6"
      ],
      "misc": [
        "fe819ff1-9db8-4a0f-85dc-0e322c9126c4"
      ],
      "singers": [
        "d4f256fc-ad8d-4df6-8602-94e12300f935"
      ],
      "songtypes": [
        "7be1b15c-cff8-4b37-a649-5c90f3d569a9"
      ],
      "songwriters": [
        "d4f256fc-ad8d-4df6-8602-94e12300f935"
      ]
    },
    "title": "Twilight",
    "year": 1983
  }
}
96 97
```

Guillaume Lebigot's avatar
Guillaume Lebigot committed
98
Some parameters are mandatory while others are generated by the Karaoke Mugen software when using its interface to add/edit a karaoke file
99

Guillaume Lebigot's avatar
Guillaume Lebigot committed
100
For more information, read the [.kara.json format documentation](http://docs.karaokes.moe/en/dev-guide/kara-content/).
101 102 103

### `lyrics` folder

Guillaume Lebigot's avatar
Guillaume Lebigot committed
104
This folder contains the subtitles files as specified in the `.kara.json` file.
105

Guillaume Lebigot's avatar
Guillaume Lebigot committed
106
It is generally a `.ass` file made with AegiSub. See [the contribution guide](CONTRIBUTING.md) for a more detailed tutorial on how to write good karaokes.
107

108
### `medias` folder
109

Guillaume Lebigot's avatar
Guillaume Lebigot committed
110
This folder contains the video or audio file as specified in the `.kara.json` file.
111

Guillaume Lebigot's avatar
Guillaume Lebigot committed
112
Videos aren't included in this git repository or else it'd be way too huge (about +250 Gb at the moment). You can launch `UpdateMedias.cmd` on Windows or `UpdateMedias.sh` on macOS/Linux to get the latest version of the `medias` folder via rsync from the Shelter server.
113

Guillaume Lebigot's avatar
Guillaume Lebigot committed
114
Launch the update script each time you pull/clone/download a new version of this repository to make sure the `medias` folder is in sync with the `.kara.json` files you just downloaded.
115

116
**If you get errors from Karaoke Mugen during database generation / folder validation, make sure you have the latest version of the repository (`git pull` or downloaded latest `master.zip`) and that you ran the `UpdateMedias` script at least twice in a row.**
117

Guillaume Lebigot's avatar
Guillaume Lebigot committed
118 119 120 121
### `series` folder

Each series (anime or real TV show, video game, etc.) has a `series.json` file which looks like this.

Guillaume Lebigot's avatar
Guillaume Lebigot committed
122
```JSON
Guillaume Lebigot's avatar
Guillaume Lebigot committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
{
  "header": {
    "version": 3,
    "description": "Karaoke Mugen Series File"
  },
  "series": {
    "name": "Mahoromatic: Automatic Maiden",
    "aliases": [
      "Automatic Maiden",
      "MM",
      "魔力女仆真幌"
    ],
    "i18n": {
      "jpn": "まほろまてぃっく Automatic Maiden",
      "fre": "Mahoromatic",
      "ger": "Mahoromatic: Automatic Maiden",
      "eng": "Mahoromatic: Automatic Maiden",
      "rus": "Махороматик: Автоматическая девушка"
    },
    "sid": "7a54c0fe-0ec2-4596-8923-fa6b92b10f00"
  }
}
```

It contains information a series, like its aliases, and its names in different languages, as well as a unique ID and an internal name (`name`). This is useful for our search engine so people can look up the karaoke of their choice no matter how they know the series are named.

Guillaume Lebigot's avatar
Guillaume Lebigot committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
### `tags` folder

A song has many tags defining its metadata, like singers, songwriters, creators, genres, etc. These are used by the search engine.

```JSON
{
  "header": {
    "description": "Karaoke Mugen Tag File",
    "version": 1
  },
  "tag": {
    "i18n": {
      "eng": "Video Game",
      "fre": "Jeu Vidéo"
    },
    "name": "Video Game",
    "tid": "dbedd6b3-d125-4cd8-aa32-c4175e4ca3a3",
    "types": [
      "families"
    ],
    "short": "VG"
  }
}
```
Guillaume Lebigot's avatar
Guillaume Lebigot committed
173

174 175 176 177 178 179 180 181
## I want to contribute and make some karaoke or send ones I already own

See [the contribution guide](CONTRIBUTING.md) for more information on how you can help.

## Can I use this freely?

See [the license](LICENSE.md)

182 183 184 185 186 187
---

# French version

## Base de données des times de Karaoke Mugen

188
Ceci est la base de données des times de [Karaoke Mugen](http://karaokes.moe).
189

190
## Format d'un time
191

192
Un karaoké Karaoke Mugen est composé de 3 éléments rangés dans des dossiers
193

Guillaume Lebigot's avatar
Guillaume Lebigot committed
194
* Un fichier `.kara.json` dans le dossier `karas`
195
* Un fichier `.ass` dans le dossier `lyrics`
196
* Un fichier vidéo ou audio dans le dossier `medias`
Guillaume Lebigot's avatar
Guillaume Lebigot committed
197
* Un fichier `.series.json` dans le dossier `series`
Guillaume Lebigot's avatar
Guillaume Lebigot committed
198
* Des fichiers `.tag.json` dans le dossier `tags`
199

200
### Dossier `karas`
201

202
Ce dossier regroupe les fichiers qui contiennent les informations permettant d'afficher le time dans la liste et que le daemon Karaoke Mugen le gère ensuite. Il reprend le format d'un .ini classique.
203 204

Exemple :
Guillaume Lebigot's avatar
Guillaume Lebigot committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
```JSON
{
  "header": {
    "version": 4,
    "description": "Karaoke Mugen Karaoke Data File"
  },
  "medias": [
    {
      "version": "Default",
      "filename": "ENG - DAICON IV - MV - Twilight.mp4",
      "audiogain": -5.61,
      "filesize": 62384194,
      "duration": 264,
      "default": true,
      "lyrics": [
        {
          "filename": "ENG - DAICON IV - MV - Twilight.ass",
          "default": true,
          "version": "Default",
          "subchecksum": "365637bcf398feb256f78773c75d81d9"
        }
      ]
    }
  ],
  "data": {
    "created_at": "Wed Oct 11 2017 19:03:04 GMT+0200 (GMT+02:00)",
    "kid": "17d535bd-101b-4ffc-836d-e26774bbb1b5",
    "modified_at": "Fri Mar 15 2019 11:19:17 GMT+0100 (GMT+01:00)",
    "repository": "kara.moe",
    "sids": [
      "987d5e61-0183-4f3f-bd9d-a1bdca12c84c"
    ],
    "tags": {
      "authors": [
        "1df04771-a378-4f14-a5e1-1455187d681a"
      ],
      "creators": [
        "0cf8c590-19cd-413a-902c-fb18f44fc385"
      ],
      "families": [
        "0377db02-3af6-43b8-9b08-c759df3d25c3"
      ],
      "groups": [
        "7792cc27-9ff9-4d47-9287-2338b7db1575",
        "f5e7d2fc-0cbb-4fb9-a84a-b25dfb0e9e77"
      ],
      "langs": [
        "de5eda1c-5fb3-46a6-9606-d4554fc5a1d6"
      ],
      "misc": [
        "fe819ff1-9db8-4a0f-85dc-0e322c9126c4"
      ],
      "singers": [
        "d4f256fc-ad8d-4df6-8602-94e12300f935"
      ],
      "songtypes": [
        "7be1b15c-cff8-4b37-a649-5c90f3d569a9"
      ],
      "songwriters": [
        "d4f256fc-ad8d-4df6-8602-94e12300f935"
      ]
    },
    "title": "Twilight",
    "year": 1983
  }
}
271
```
272

Guillaume Lebigot's avatar
Guillaume Lebigot committed
273
Certains éléments sont obligatoires, d'autres sont générés par le logiciel Karaoke Mugen lors de la création/édition de karaoké
274

275
Pour plus d'informations, consultez la [documentation sur le format](http://mugen.karaokes.moe/docs/fr/dev-guide/kara-content/)
276

277
### Dossier `lyrics`
278

279
Contient le fichier de sous-titres tel que spécifié dans le .kara
280

281
Il s'agit d'un .ass généralement crée via AegisSub. Voyez [le guide de contribution](CONTRIBUTING.md) pour des tutoriels sur comment faire de bons karaokés dans ce format.
282

283
### Dossier `medias`
284

285
Contient le fichier de vidéo ou d'audio tel que spécifié dans le .kara
286

Guillaume Lebigot's avatar
Guillaume Lebigot committed
287
Les vidéos ne sont pas fournies dans ce dépôt, par souci de place (et ça ferait un dépôt de +250 Go au bas mot). Vous pouvez néanmoins lancer `UpdateMedias.cmd` (Windows) ou `UpdateMedias.sh` (OSX/Linux) pour récupérer les vidéos par rsync depuis le serveur Shelter.
288 289

Pensez à lancer régulièrement ce script, parfois deux fois de suite pour vous assurer que tout a bien été récupéré. Le dossier de vidéos colle à la dernière version de la base.
290

291
Si vous rencontrez des erreurs de Karaoke Mugen durant la génération de la base / la validation des dossiers, assurez-vous que vous avez bien la dernière version de ce dépôt (`git pull` ou téléchargez le dernier `master.zip`) et lancez le script `UpdateVideos` deux fois d'affilée pour être sûr.
292

Guillaume Lebigot's avatar
Guillaume Lebigot committed
293 294 295 296
### Dossier `series`

Chaque série (anime, série télé, jeu vidéo, etc.) possède un fichier `.series.json` qui ressemble à ceci :

Guillaume Lebigot's avatar
Guillaume Lebigot committed
297
```JSON
Guillaume Lebigot's avatar
Guillaume Lebigot committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
{
  "header": {
    "version": 3,
    "description": "Karaoke Mugen Series File"
  },
  "series": {
    "name": "Mahoromatic: Automatic Maiden",
    "aliases": [
      "Automatic Maiden",
      "MM",
      "魔力女仆真幌"
    ],
    "i18n": {
      "jpn": "まほろまてぃっく Automatic Maiden",
      "fre": "Mahoromatic",
      "ger": "Mahoromatic: Automatic Maiden",
      "eng": "Mahoromatic: Automatic Maiden",
      "rus": "Махороматик: Автоматическая девушка"
    },
    "sid": "7a54c0fe-0ec2-4596-8923-fa6b92b10f00"
  }
}
```

Il contient des informations sur une série, comme ses alias, ses noms dans différentes langues, ainsi qu'un ID unique et un nom interne (`name`). Cela permet aux utilisateurs de trouver à coup sûr le karaoké de leur choix via le moteur de recherche.

Guillaume Lebigot's avatar
Guillaume Lebigot committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
### Dossier `tags`

Un karaoké est relié à différents fichiers tags qui le définissent. Chanteurs, compositeurs, genres, créateurs, tout est dans un fichier tag dédié comme celui-ci :

```JSON
{
  "header": {
    "description": "Karaoke Mugen Tag File",
    "version": 1
  },
  "tag": {
    "i18n": {
      "eng": "Video Game",
      "fre": "Jeu Vidéo"
    },
    "name": "Video Game",
    "tid": "dbedd6b3-d125-4cd8-aa32-c4175e4ca3a3",
    "types": [
      "families"
    ],
    "short": "VG"
  }
}
```

349 350 351 352
## Je veux aider et faire ou envoyer des karaokes a la base

Lisez [le guide de contribution](CONTRIBUTING.md) pour savoir comment faire et trouver de l'aide.

353
## Puis-je utiliser tout ça gratuitement ?
354 355

Voir [la license d'utilisation](LICENSE.md)