README.md 7.77 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


10
# English version
11

12 13
## Karaoke Mugen database

14
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.
15 16 17 18 19 20

## Format

A karaoke is made of the following elements :

* A `.kara` file in the `karas` folder
21
* A `.ass` file in the `lyrics` folder
22
* A video or audio file in the `medias` folder
Guillaume Lebigot's avatar
Guillaume Lebigot committed
23
* A `.series.json` file in the `series` folder
24 25 26 27 28 29 30

### `karas` folder

This folder holds files with karaoke metadata such as video file, lyrics file, etc. It uses the standard `.ini` format.

Example :
```
31
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
32 33 34 35 36 37 38 39 40 41
subfile=ANG - Porter Robinson & Madeon - MV - Shelter.ass
year=2016
singer=Amy Millan
tags=
songwriter=Porter Robinson,Madeon
creator=A-1 Pictures
author=karaokes.moe
series=Shelter
lang=eng
KID=48d98d72-fe99-4eca-84be-bae0d598e169
42 43 44 45
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
46 47 48 49
dateadded=1507741308
title=Shelter
type=MV
order=
50
version=3
51 52
```

53
Some parameters are mandatory while others are generated by the Karaoke Mugen software when launching it with the `--generate` option.
54

55
For more information, read the [.kara format documentation](http://mugen.karaokes.moe/docs/fr/dev-guide/kara-content/) in french.
56 57 58 59 60

### `lyrics` folder

This folder contains the subtitles files as specified in the `.kara` file.

61
It is generally a `.ass` file made with AegisSub. See [the contribution guide](CONTRIBUTING.md) for a more detailed tutorial on how to write good karaokes.
62

63
### `medias` folder
64

65
This folder contains the video or audio file as specified in the `.kara` file.
66

67
Videos aren't included in this git repository or else it'd be way too huge (about 210Gb 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.
68

69
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` files you just downloaded.
70

71
**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.**
72

Guillaume Lebigot's avatar
Guillaume Lebigot committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
### `series` folder

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

```
{
  "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.


105 106 107 108 109 110 111 112
## 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)

113 114 115 116 117 118
---

# French version

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

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

121
## Format d'un time
122

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

125 126
* Un fichier `.kara` dans le dossier `karas`
* Un fichier `.ass` dans le dossier `lyrics`
127
* Un fichier vidéo ou audio dans le dossier `medias`
Guillaume Lebigot's avatar
Guillaume Lebigot committed
128
* Un fichier `.series.json` dans le dossier `series`
129

130
### Dossier `karas`
131

132
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.
133 134

Exemple :
135
```
136
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
137 138 139 140 141 142 143 144
subfile=ANG - Porter Robinson & Madeon - MV - Shelter.ass
year=2016
singer=Amy Millan
tags=
songwriter=Porter Robinson,Madeon
creator=A-1 Pictures
author=karaokes.moe
series=Shelter
145 146
lang=eng
KID=48d98d72-fe99-4eca-84be-bae0d598e169
147 148 149 150
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
151
dateadded=1507741308
152 153 154
title=Shelter
type=MV
order=
155
version=3
156
```
157

158
Certains éléments sont obligatoires, d'autres sont générés par le logiciel Karaoke Mugen lors de la validation des fichiers .kara
159

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

162
### Dossier `lyrics`
163

164
Contient le fichier de sous-titres tel que spécifié dans le .kara
165

166
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.
167

168
### Dossier `medias`
169

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

172
Les vidéos ne sont pas fournies dans ce dépôt, par souci de place (et ça ferait un dépôt de 210 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.
173 174

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

176
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.
177

Guillaume Lebigot's avatar
Guillaume Lebigot committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
### Dossier `series`

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

```
{
  "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.

209 210 211 212
## 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.

213
## Puis-je utiliser tout ça gratuitement ?
214 215

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