Le Lab de Shelter a été mis à jour en 10.8

Vous pouvez désormais faire des Push Mirror, si vous souhaitez sauvegarder vos dépôts sur un autre gitlab ou sur github. Ca fait que quand vous poussez des commits ici (c'est votre dépôt principal) ça répercute les push ailleurs.

La double sauvegarde, c'est toujours une bonne idée.

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

3
# English version
4

5 6 7 8 9 10 11 12 13
## Karaoke Mugen database

This is the git repository for the [Karaoke Mugen](http://mugen.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.

## 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 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
* A video file in the `videos` folder

### `karas` folder

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

Example :
```
videofile=ANG - Porter Robinson & Madeon - MV - Shelter.mp4
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
videosize=109238678
videoduration=367
videogain=-5.49
dateadded=1507741308
title=Shelter
type=MV
order=
version=1
```

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

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

### `lyrics` folder

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

52
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.
53 54 55 56 57 58 59 60 61 62 63

### `videos` folder

This folder contains the video file as specified in the `.kara` file.

Videos aren't included in this git repository or else it'd be way too huge (about 170Gb at the moment). You can launch `UpdateVideos.cmd` on Windows or `UpdateVideos.sh` on macOS/Linux to get the latest version of the videos folder via rsync from the Shelter server.

Launch the update script each time you pull/clone/download a new version of this repository to make sure the videos folder is in sync with the `.kara` files you just downloaded.

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 `UpdateVideos` script at least twice in a row.

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

72 73 74 75 76 77 78 79
---

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

80
## Format d'un time
81

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

84 85 86
* Un fichier `.kara` dans le dossier `karas`
* Un fichier `.ass` dans le dossier `lyrics`
* Un fichier vidéo dans le dossier `videos`
87

88
### Dossier `karas`
89

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

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

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

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

119
### Dossier `lyrics`
120

121
Contient le fichier de sous-titres tel que spécifié dans le .kara
122

123
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.
124

125
### Dossier `videos`
126

127
Contient le fichier de vidéo tel que spécifié dans le .kara
128

129 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 `Mettre a jour videos.cmd` (Windows) ou `UpdateVideos.sh` (OSX/Linux) pour récupérer les vidéos par rsync depuis le serveur Shelter.

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

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

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

## Puis-je utiliser tout ça gratuitement?

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