Commit 86a61dc8 authored by Guillaume Lebigot's avatar Guillaume Lebigot

MAJ des fichiers de documentation

parent feb7d6ff
......@@ -10,7 +10,7 @@ C'est sûr que plus on est nombreux, plus ça va vite de maintenir cette base à
Discutons-en sur Discord (voir plus bas). On prend toutes les bonnes volontés !
Il y a notamment des karaokés dont il faut vérifier le titre, mais aussi les paroles.
Il y a notamment des karaokés dont il faut vérifier le titre, mais aussi les paroles.
Si rien de tout cela ne vous botte, il y a toujours le boulot de tag les karaokés, c'est à dire remplir leurs .kara d'informations comme l'année de l'animé, le studio de production, le chanteur ou le compositeur, etc.
......
......@@ -4,10 +4,11 @@ Les vidéos accessibles depuis le script disponible dans le dépôt sont la prop
Dans la mesure du possible, l'auteur d'un karaoké est indiqué dans le .kara correspondant, mais nombre de karaokés n'ont aucun auteur déclaré.
Vous pouvez utiliser cette base comme bon vous semble tant qu'elle est créditée quelque part.
Vous pouvez utiliser cette base comme bon vous semble tant qu'elle est créditée quelque part.
La base en elle-même utilise une license MIT
```
MIT License
Copyright (c) [year] [fullname]
......@@ -29,5 +30,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
\ No newline at end of file
......@@ -16,26 +16,30 @@ C'est le fichier qui contient les informations permettant d'afficher le time dan
Exemple :
```
videofile="ANG - Porter Robinson & Madeon - CLIP - Shelter.mp4"
subfile="ANG - Porter Robinson & Madeon - CLIP - Shelter.ass"
year="2016"
singer="Amy Millan"
tags=""
songwriter="Porter Robinson,Madeon"
lang="eng"
creator="A-1 Pictures"
author="karaokes.moe"
series="Shelter"
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
lang=eng
creator=A-1 Pictures
author=karaokes.moe
series=Shelter
title=Shelter
type=MV
order=
version=1
```
Les trois éléments obligatoires sont :
Certains éléments sont obligatoires, comme :
* **videofile** : Nom du fichier vidéo, tel quel dans le dossier des Vidéos. Karaoke Mugen lit tout ce que peut lire mpv.
* **subfile** : Nom du fichier de sous-titres tel que trouvable dans le dossier lyrics (en .ass)
* Cas spécial : dummy.ass qui n'existe pas et est utilisé quand le fichier vidéo contient déjà des sous-titres, soit incrustés (hardsub) soit embarqués (ass dans la piste sous-titres d'un mkv. Dans ce cas, Karaoke Mugen ira extraire le sous-titre à la volée avant la lecture du karaoké pour ajouter le titre de la chanson en bas de l'écran pendant quelques secondes.
* **lang** : code ISO 639-2B de la langue utilisée.
La description des autres éléments se trouvent dans [CONTRIBUTING.md]
Pour plus d'informations, consultez la [documentation sur le format](docs/karaformat.md)
### Dossier "lyrics"
......@@ -47,5 +51,6 @@ Il s'agit d'un .ass généralement crée via AegisSub. Voyez [CONTRIBUTING.md] p
Contient le fichier de vidéo tel que spécifié dans le .kara
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.
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.
\ No newline at end of file
# Le fichier .kara
C'est un fichier de métadonnées pour votre karaoké, il est primordial : il indique à **Karaoke Mugen** où sont les fichiers à utiliser ainsi que d'autres infos pour générer sa base de données.
## Exemple de .kara
### Nom du fichier
Prenons par exemple le fichier `.kara` suivant :
```
JAP - 3-gatsu no Lion - OP1 - Answer.kara
```
Il s'agit de l'opening japonais de la série "3-gatsu no Lion", une adaptation d'un excellent manga de Chica Umino.
Ceci est une convention de nommage, elle est donc parfaitement optionnelle et n'a aucune incidence pour **Karaoké Mugen**, elle est là pour vous aider à vous y retrouver dans vos fichiers.
```
Langue - Série - Type - Titre.kara
```
- `Langue` : Ce paramètre n'est pas pris en compte dans la génération, mais il est là pour vous aider à trier les fichiers de votre base, à différencier l'opening français de Naruto de son opening japonais, par exemple. La langue est indiquée ailleurs, nous le verrons plus tard. Exemples de nommage (que vous n'êtes pas obligés de respecter):
- `ALL` : allemand
- `ANG` : anglais
- `CHI` : chinois
- `COR` : corréen
- `EPO` : espéranto
- `ESP` : espagnol
- `FIC` : fictive (langue qui n'existe pas)
- `FR` : français
- `HEB` : hébreu
- `ITA` : italien
- `JAP` : japonais
- `LAT` : latin
- `POR` : portugais
- `RUS` : russe
- `SUE` : suèdois
- `Série` : La série, ou chanteur d'un .kara
- S'il s'agit d'une vidéo musicale (`MV`), la série n'a pas toujours sens, du coup c'est le nom du chanteur/euse/groupe qui est mis à la place. Exemple : `JAP - World Order - MV - BOY MEETS GIRL` pour le vidéoclip du groupe japonais World Order.
- `Type` : une abréviation en majuscules suivi d'un (ou aucun) numéro pour préciser l'ordre. Le type de votre kara doit être parmi les types suivants :
- `AMV` : Anime Music Video. Montages amateurs autour d'animés.
- `CM` : Publicité.
- `ED` : Ending d'un animé.
- `IN` : Insert song (chanson qui passe en plein milieu d'un épisode).
- `OT` : Autre/inclassable.
- `TRAILER` : Vidéo promotionnelle (trailer, bande-annonce, etc.).
- `LIVE` : Concerts.
- `OP` : Opening d'un animé.
- `MV` : Vidéo musicale (clips musicaux).
- `Titre` : C'est le titre de la chanson, tout simplement !
Pour plus d'informations sur comment nommer vos fichiers, consultez le [tutorial de création de karaoké disponible sur le dépot de la base](https://lab.shelter.moe/karaokemugen/karaokebase/blob/master/docs/tutorial.md).
### Le contenu du fichier .kara
Reprenons notre exemple de l'OP de "3-gatsu no Lion".
```
videofile=JAP - 3-gatsu no Lion - OP1 - Answer.mkv
subfile=dummy.ass
year=2016
singer=BUMP OF CHICKEN
tags=TAG_ANIME,TAG_TVSHOW
songwriter=Motoo Fujiwara
creator=Shaft
author=Bakaclub
series=3-gatsu no Lion
title=Answer
type=OP
order=
lang=jpn
KID=fcb32b00-c7d5-470e-9f98-32edd1b67e18
videosize=44241053
videoduration=89
videogain=-2.18
version=1
```
N'ayez pas peur, tout n'est pas à remplir par vous-même (mais une grande partie si quand même).
- `videofile` : Nom du fichier vidéo, obligatoire, tel qu'on le trouve dans le répertoire `app/data/videos`.
- `subfile` : Nom du fichier de sous-titrage des paroles, obligatoire aussi et tel qu'on le trouve dans le répertoire `app/data/lyrics`.
- Si aucun fichier requis, indiquez `dummy.ass` (par exemple si votre vidéo contient des sous-titres embarqués ou incrustés).
- `year` : Année de production de la série/vidéo.
- `singer` : Chanteur/euse, ou groupe qui chante. Si plusieurs chanteurs, séparer par des virgules.
- `tags` : Une liste de tags séparés par des virgules, pouvant servir à mieux catégoriser votre karoaké. Voici la liste des tags reconnus actuellement :
- `TAG_SPECIAL` : Spécial.
- `TAG_VOICELESS` : Karaoké sans voix (si si).
- `TAG_GAMECUBE` : Gamecube.
- `TAG_TOKU` : Tokusatsu/Sentai.
- `TAG_OVA` : Original Video Animation, réservé aux séries qui n'ont pas eu de diffusion télé mais uniquement sur support (VHS/DVD/BR)
- `TAG_ONA` : Original Network Animation, réservé aux webséries
- `TAG_MECHA` : Animé de méchas.
- `TAG_CONCERT` : Concert.
- `TAG_PARODY` : Parodie.
- `TAG_HUMOR` : Humour.
- `TAG_ANIME` : Anime.
- `TAG_REAL` : Non-animé.
- `TAG_VIDEOGAME` : Jeu vidéo (sans tiret, sans S).
- `TAG_MOVIE` : Film.
- `TAG_TVSHOW` : Série.
- `TAG_SPOIL` : Spoilers (tout le monde ne sait pas qui est le père de Luke).
- `TAG_LONG` : Long (chanson estimée longue)
- `TAG_PS2` : PS2.
- `TAG_PS3` : PS3.
- `TAG_PSV` : PSVita.
- `TAG_PSX` : PSOne.
- `TAG_PSP` : PSP.
- `TAG_R18` : Pour adultes (On sait que vous allez les rechercher tout de suite).
- `TAG_VOCALOID` : Vocaloid.
- `TAG_XBOX360` : XBOX 360.
- `TAG_PC` : PC.
- `TAG_SEGACD` : Mega CD.
- `TAG_REMIX` : Remix (version alternative des paroles, parodique le plus souvent).
- `songwriter` : Nom du ou des compositeurs. Séparer par des virgules si plusieurs compositeurs.
- `creator` : Nom de l'entité qui a crée la série/vidéo.
- `author` : C'est vous ! Mettez votre pseudonyme pour montrer à la terre entière que vous avez écrit un karaoké !
- `series` : Nom de la série dont le karaoké est tiré. Si vous faites le karaoké d'une vidéo musicale en relation avec un animé, par exemple le clip de *Zen Zen Zense* de *RADWIMPS* alors indiquez *Your Name* dans `series`.
- `title` : Titre de la chanson
- `type` : L'un des types suivants :
- `AMV` : Anime Music Video. Montages amateurs autour d'animés.
- `CM` : Publicité.
- `ED` : Ending d'un animé.
- `IN` : Insert song (chanson qui passe en plein milieu d'un épisode).
- `OT` : Autre/inclassable.
- `TRAILER` : Vidéo promotionnelle (trailer, bande-annonce, etc.).
- `LIVE` : Concerts.
- `OP` : Opening d'un animé.
- `MV` : Vidéo musicale (clips musicaux).
- `order` : Numéro de l'opening/ending. Peut être vide.
- `lang` : Indiquer le code ISO639-2B sur 3 caractères de la langue. Pour connaître la liste des langues de cette norme, consultez [l'article Wikipédia à son sujet](https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-2) ! Par exemple, le code ISO639-2B du japonais est `jpn`.
- `version` : Format du .kara (version 1)
Les quatre dernières lignes sont remplies automatiquement par **Karaoke Mugen** lors de la génération, vous n'avez donc pas à vous en préoccuper, mais pour l'exhaustivité nous allons expliquer à quoi elles servent. Attention, si vous modifiez le fichier vidéo d'un karaoké, ces valeurs seront modifiées automatiquement lors de la génération de la base de données (ou au lancement du logiciel).
* `KID` : Il s'agit d'un identifiant unique (UUID) permettant d'identifier le karaoké dans la base de données. Ainsi, quand vous passez une playlist à quelqu'un, ou que vous régénérez la base, les playlists retrouveront leurs karaokés dans la base de données. **Si deux karaokés ont le même `KID`, l'univers peut imploser, donc attention : modifier cette valeur au hasard est le meilleur moyen de corrompre votre base de données.**
* `videosize` : Taille en octets de la vidéo, cela permet à **Karaoke Mugen** de repérer si vous avez remplacé le fichier vidéo. Si c'est le cas, la base de données sera regénérée et les valeurs suivantes recalculées.
* `videogain` : Gain audio de la vidéo. Il est calculé lors de la génération via *FFMPEG*. Cela permet d'égaliser le son de toutes les vidéos de votre base de données pour éviter les sursauts de changement de volume lors du passage d'une chanson à l'autre.
* `videoduration` : Détecté aussi lors de la génération de la base de données, il permet de savoir combien de temps en secondes dure la vidéo. Cette valeur permet ensuite de gérer l'animation de la barre de progression sur l'interface utilisateur.
* `dateadded` : Date when it was added in the database.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment