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

3
# English version
4

5 6
## Karaoke Mugen database

7
This is the git repository for the [Karaoke Mugen](http://mugen.karaokes.moe/en) 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.
8 9 10 11 12 13

## Format

A karaoke is made of the following elements :

* A `.kara` file in the `karas` folder
14
* A `.ass` file in the `lyrics` folder
15
* A video or audio file in the `medias` folder
16 17 18 19 20 21 22

### `karas` folder

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

Example :
```
23
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
24 25 26 27 28 29 30 31 32 33
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
34 35 36 37
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
38 39 40 41
dateadded=1507741308
title=Shelter
type=MV
order=
42
version=3
43 44
```

45
Some parameters are mandatory while others are generated by the Karaoke Mugen software when launching it with the `--validate` or `--generate` options.
46

Florent Berthelot's avatar
Florent Berthelot committed
47
For more information, read the [.kara format documentation](docs/french/karafile.md) in french.
48 49 50 51 52

### `lyrics` folder

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

53
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.
54

55
### `medias` folder
56

57
This folder contains the video or audio file as specified in the `.kara` file.
58

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

61
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.
62

63
**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.**
64

65 66 67 68 69 70 71 72
## 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)

73 74 75 76 77 78 79 80
---

# French version

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

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

81
## Format d'un time
82

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

85 86
* Un fichier `.kara` dans le dossier `karas`
* Un fichier `.ass` dans le dossier `lyrics`
87
* Un fichier vidéo ou audio dans le dossier `medias`
88

89
### Dossier `karas`
90

91
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.
92 93

Exemple :
94
```
95
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
96 97 98 99 100 101 102 103
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
104 105
lang=eng
KID=48d98d72-fe99-4eca-84be-bae0d598e169
106 107 108 109
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
110
dateadded=1507741308
111 112 113
title=Shelter
type=MV
order=
114
version=3
115
```
116

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

Florent Berthelot's avatar
Florent Berthelot committed
119
Pour plus d'informations, consultez la [documentation sur le format](docs/french/karafile.md)
120

121
### Dossier `lyrics`
122

123
Contient le fichier de sous-titres tel que spécifié dans le .kara
124

125
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.
126

127
### Dossier `medias`
128

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

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

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

135
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.
136 137 138 139 140

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

141
## Puis-je utiliser tout ça gratuitement ?
142 143

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