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



11
# English version
12

13 14
## Karaoke Mugen database

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

## Format

A karaoke is made of the following elements :

* A `.kara` file in the `karas` folder
22
* A `.ass` file in the `lyrics` folder
23
* A video or audio file in the `medias` 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

73 74 75 76 77 78 79 80
## 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)

81 82 83 84 85 86
---

# French version

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

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

89
## Format d'un time
90

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

93 94
* Un fichier `.kara` dans le dossier `karas`
* Un fichier `.ass` dans le dossier `lyrics`
95
* Un fichier vidéo ou audio dans le dossier `medias`
96

97
### Dossier `karas`
98

99
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.
100 101

Exemple :
102
```
103
mediafile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
104 105 106 107 108 109 110 111
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
112 113
lang=eng
KID=48d98d72-fe99-4eca-84be-bae0d598e169
114 115 116 117
mediasize=109238678
mediaduration=367
mediagain=-5.49
subchecksum=abcdef1234567890
118
dateadded=1507741308
119 120 121
title=Shelter
type=MV
order=
122
version=3
123
```
124

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

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

129
### Dossier `lyrics`
130

131
Contient le fichier de sous-titres tel que spécifié dans le .kara
132

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

135
### Dossier `medias`
136

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

139
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.
140 141

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

143
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.
144 145 146 147 148

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

149
## Puis-je utiliser tout ça gratuitement ?
150 151

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