Commit a8dd6541 authored by Guillaume Lebigot's avatar Guillaume Lebigot

First fixes for 3.0.0

parent 44741752
......@@ -4,7 +4,7 @@ If you have a suggestion, a wish, or need help, there are several ways to contac
* Via email : karaokemugen at shelter.moe
* Via Twitter : [@KaraokeMugen](http://twitter.com/karaokemugen)
* Via Discord : [#karaoke channel on discord Eden de la Nanami](https://discord.gg/XFXCqzU)
* Via Discord : [#karaoke channel on discord Eden de la Nanami](http://karaokes.moe/discord)
## Bugs
......
......@@ -18,6 +18,10 @@
* 7 : Ban on misc tags
* 8 : Ban on songwriter
* 9 : Ban on downloadable groups
* 10 : Ban on family
* 11 : Ban on origin
* 12 : Ban on genre
* 13 : Ban on platform
* 1000 : Ban on series' name. Example : `Gundam` will ban `Mobile Suit G Gundam` and `Gundam SEED`
* 1001 : Ban on exact karaoke ID. Used to ban specific karaoke songs. Value should contain a single karaoke ID.
* 1002 : Ban song if longer than xx seconds.
......
......@@ -4,6 +4,84 @@
[See current documentation on kara files](/user-guide/manage)
### Version 4
Compatible with Karaoke Mugen 3.0.0 and above.
Self-explanatory JSON example :
```JSON
{
"header": {
"version": 4,
"description": "Karaoke Mugen Karaoke Data File"
},
"medias": [
{
"version": "Default",
"filename": "ENG - Portal 2 - PC GAME ED - Want You Gone.mp4",
"audiogain": 1.93,
"filesize": 30578533,
"duration": 145,
"default": true,
"lyrics": [
{
"filename": "ENG - Portal 2 - PC GAME ED - Want You Gone.ass",
"default": true,
"version": "Default",
"subchecksum": "cc116b584fb9097b8246369c45e4f733"
}
]
}
],
"data": {
"created_at": "Wed Oct 11 2017 19:01:47 GMT+0200 (GMT+02:00)",
"kid": "c237d00a-3dd2-4884-9a68-8c0638734dd4",
"modified_at": "Sun Jul 29 2018 15:12:56 GMT+0200 (GMT+02:00)",
"repository": "kara.moe",
"sids": [
"a7e45824-e4b8-415f-a0ee-125ba7f43a9c"
],
"title": "Want You Gone",
"platforms": [
"3c15f758-e1bc-4266-8bb9-3c14112f504a"
],
"tags": {
"authors": [
"5bdaba57-27f8-4568-8806-76a807728766"
],
"creators": [
"4b4e7060-c4a2-42db-bc76-871d266b41fc"
],
"families": [
"dbedd6b3-d125-4cd8-aa32-c4175e4ca3a3"
],
"groups": [
"ae613721-1fbe-480d-ba6b-d6d0702b184d",
"9c79e1bb-a5b9-4059-ad20-4687ec733371"
],
"langs": [
"de5eda1c-5fb3-46a6-9606-d4554fc5a1d6"
],
"platforms": [
"3c15f758-e1bc-4266-8bb9-3c14112f504a"
],
"singers": [
"48c64b08-3394-41c1-a804-a2f26824330e"
],
"songtypes": [
"38c77c56-2b95-4040-b676-0994a8cb0597"
],
"songwriters": [
"7658bb92-03da-4d66-905f-8d6b866e4459"
]
},
"year": 2011
}
}
```
### Version 3
Only compatible with Karaoke Mugen v2.2.0 and higher
......
......@@ -90,6 +90,25 @@ Web interface settings
- `false` : Users can't view the blacklist criterias
- `true` : Users can view the blacklist criterias (default)
### Gitlab
Specific settings if your Karaoke Mugen instance is linked to a Gitlab one, for automatic creation of an issue when someone makes a song suggestion that isn't included in your database.
- `Enabled` : `true` or `false`
- `Host` : Complete URL (with https://) to your Gitlab instance
- `Token` : Access token for the user who will post issues for you.
- `ProjectID` : Gitlab Project ID to post issues to.
#### Template
Issue templates
##### Suggestion
- `Description` : Issue description. You can add `$username` which will be replaced by the name of the user who asked for a song.
- `Title` : Issue title. `$kara` is the unknown song name your user suggested.
- `Labels` : Label list to add to the created issues.
### Karaoke
Karaoke session specific settings
......@@ -97,6 +116,9 @@ Karaoke session specific settings
* `AutoPlay` : If no song is being played, playback will start as soon as a song is added to the list.
- `false` : Starting playback is manual (default)
- `true` : Playback automatically starts if a song is added
* `ClassicMode` : If enabled, playback will stop after each song, allowing only the admin or the user who requested the next song to start playing again from their device.
- `false` : Classic mode disabled
- `true` : Classic mode enabled
* `CreatePreviews` :
- `false` : No preview video will be created
- `true` : At startup, Karaoke Mugen will verify if some songs need to have their video preview generated. If some previews are missing, KM will create them with FFMPEG. This can last for a while seeing how many songs with have in the database at the moment. Preview creation cannot be interrupted, but if you close KM and start it again, it will resume where it left off.
......@@ -157,6 +179,19 @@ A freed song doesn't count anymore towards a user's quota.
* `FreeUpVotesRequiredPercent` : Percentage (0-100) of likes required to get a song freed. It's the percentage of people marked as connected to the app at a given time.
* `FreeUpVotesRequiredMin` : Minimum number of likes required for a song to be freed.
#### StreamerMode
The Streamer Mode displays poll results during song pauses, and can also allow Twitch chatters to submit their votes. It also adds a configurable pause inbetween songs.
* `Enabled` : `true` or `false` depending on if you want that mode or not
* `PauseDuration` : In seconds.
##### Twitch
* `Enabled` : `true` or `false` depending on if you're using Twitch Chat or not
* `ClientID` : Your Twitch Client ID
* `accessToken` : Your Twitch Access Token
### Player
* `mpvVideoOutput` : You can specify a video driver for mpv here. If under Windows you see a blue window when launching Karaoke Mugen, put `direct3d` in this.
......@@ -206,6 +241,7 @@ A freed song doesn't count anymore towards a user's quota.
### Playlist
* `AllowDuplicates` : A song can be added more than once if this setting is set to `true` (only on non-public playlists)
* `AllowDuplicateSeries` : Can a song be added if another song from the same series or singer is already present in playlist?
* `MaxDejaVuTime` : A song is marked as "deja vu" if it's been played less than xx minutes ago (60 by default)
* `RemovePublicOnPlay` : Remove songs from public playlists as soon as they're played.
......@@ -241,7 +277,8 @@ When searching for a file in these, Karaoke Mugen will go through every entry of
* `Lyrics` : Folders where to look for `.ass` files.
* `Medias` : Folders where to look for media files.
* `Previews` : Folder where previews are stored (about 500Kb per song)
* `Series` : Folders where `.series.json` file sare stored
* `Series` : Folders where `.series.json` files are stored
* `Tags` : Folders where `.tag.json` files are stored
* `Temp` : Temporary folder. It is cleaned on startup.
* `MediasHTTP`: URL where songs are stored. If they are not availeble in the `Medias` folders, Karaoke Mugen will try to stream them from that URL.
......
......@@ -12,11 +12,9 @@ Please keep it in a safe place, it will not be displayed ever again.
To reset admin password, set appFirstRun to 1 in config.yml
```
And voilà, you've revovered your password.
Otherwise open the `config.yml` and look for the `firstRun` setting. Change it's value from `false` to `true`.
Close the application.
Launch Karaoke Mugen to read again completely the tutorial and create a new admin account.
You can afterward, thanks to this new account, come back into the management interface of the options to reinitialise the password of your old account.
And voilà, you've recovered your password.
If it's not the first time you're running Karaoke Mugen you can force a new admin password with the `--forceAdminPassword <passowrd>` command-line argument where `<password>` is the new admin password you desire. You only need to do this once.
## My karaokes list is empty or incomplete.
......@@ -26,9 +24,9 @@ If it's your first launch, it will display the existings karas in the `samples`
Alternatively, if you have followed the [starting guide](../getting-started/#karaoke-database), and that you get the existing base, it should display the existings karas into the `app/data` folder.
If you have a different folder to store your karaokes, so verify the content of the `config.yml` file. You should find inside a `PathMedias = "app/data/medias"` line.
If you have a different folder to store your karaokes, so verify the content of the `config.yml` file. You should find all paths under the `System` and `Path` categories.
Verify that this line show a path to the right folder containing your videos or audio files. Do it again with the `PathKaras` and `PathSubs` variables.
Verify that this line shows a path to the right folder containing your videos or audio files. Do it again with the `Karas` and `Lyrics`, `Series` and `Tags` variables.
You cannot modify those path from the administration interface, since they're used at the start.
......@@ -44,11 +42,11 @@ If you have a `config.yml` file, open it and add the following : `mpvVideoOutput
## How much space is needed for Karaoke Mugen?
The software should take abotu 200 Mb of disk space, but the karaoke database is about 170 Gb big.
The software should take abotu 200 Mb of disk space, but the karaoke database can take several hundred gigabytes.
## Can I download only part of the base?
For now that is not possible, but an [issue](https://lab.shelter.moe/karaokemugen/karaokemugen-app/issues/117) is open for that. If you think you can help, don't hesitate!
A Download manager still in Beta is available in the System Control Panel.
## Errors during database generation
......@@ -58,4 +56,4 @@ This means you have two .kara files sharing the same KID in your base. KIDs are
### `Media file not found`
Make sure you have all videos and other media, and verify that it isn't misspelled in the .kara file or on your filesystem.
\ No newline at end of file
Make sure you have all videos and other media, and verify that it isn't misspelled in the .kara file or on your filesystem.
......@@ -25,7 +25,7 @@ You can create your own karaoke base, go to [manage your karaoke database](../ma
### Use the samples
A group of 6 karaokes (actually 3 different ones) is bundled with the app in the `samples` folder. It is also automatically copied in the `app/data` folder if no karaoke is found.
A group of 6 karaokes is bundled with the app in the `samples` folder. It is also automatically copied in the `app/data` folder if no karaoke is found.
### Get an existing database
......@@ -37,7 +37,7 @@ You can install the complete base in different ways :
In the **Database** tab you can click on **Update** to download the last version of the base and its videos. Les messages s'affichent dans la console de Karaoke Mugen
**WARNING :** Video files take a lot of space (about 190Gb), make sure you have enough disk space before launching the update.
**WARNING :** Video files take a lot of space (several hundreds of giga-bytes,) make sure you have enough disk space before launching the update.
You can quit Karaoke Mugen anytime and continue the update at a later time.
......@@ -149,11 +149,11 @@ If generation was successful, the console window should display correct stats :
11:06:23 - info: [Engine] Karaoke Mugen is READY
```
Another window should also appear in the lower left corner of your screen with a wallpaper, connection info and a QR Code.
Another window should also appear in the lower left corner of your screen with a wallpaper and connection info.
![Background](../img/background.png)
The QR Code and the URL at the bottom will allow your users to connect to the karaoke selection interface. This is your **local network address**. This is not your internet IP. Only people on your Wifi network can participate.
The URL at the bottom will allow your users to connect to the karaoke selection interface. This is your **local network address**. This is not your internet IP. Only people on your Wifi network can participate.
You can enable a short URL option in the settings page. It'll allow your users to go to [http://kara.moe](http://kara.moe) which will make it easier for them to type when wanting to join your karaoke session. You and your users must be connected to the Internet for this to work.
......
......@@ -11,7 +11,7 @@ You can install Karaoke Mugen by downloading its source code.
- Download [ffmpeg](http://ffmpeg.org) and place the `ffmpeg` executable in the `app/bin` folder.
- Version 3.3.1 is the minimum requirement
- Download [nodeJS](https://nodejs.org/en/download/) which is required for Karaoke Mugen to run.
- Minimum version required is 10.9.x. Karaoke Mugen is not compatible with Node 11 yet.
- Minimum version required is 10.9.x.
- Install nodeJS once it's been downloaded
- Download [PostgreSQL](http://postgresql.org)
- Minimum version required is 10.6. You can try with 9.x versions but it hasn't been battle tested.
......
......@@ -14,10 +14,11 @@ To import data and create its databases, Karaoke Mugen needs to know where to fi
A karaoke base folder has three subfolders which are named by default :
* `karas` : All the `.kara` files, which are metadata about your karaoke songs.
* `karas` : All the `.kara.json` files, which are metadata about your karaoke songs.
* `lyrics` : All the `.ass` files, which are subtitles and the actual karaoke files.
* `medias` : All the medias (`.mkv/avi/webm/mp4/mp3/ogg...`) used for karaoke.
* `series` : All the `.series.json`files, which are metadata about your series
* `series` : All the `.series.json` files, which are metadata about your series
* `tags` : All the `.tag.json` files, which are metadata about tags used in your kara files
Typically, you'll get a foledr structure like this :
......@@ -28,15 +29,16 @@ app
- lyrics
- medias
- series
- tags
```
These folders are configurable in the `config.yml` file. See the [configuration](configuration) section for more details. You can, for example, have videos on an external hard drive or network share to save space.
## .kara files
## .kara.json files
This file stores metadata about your karaoke, it is mandatory : it tells Karaoke Mugen where your subtitle and video files are, as well as other information it needs to generate its database.
`.kara` files can be generated from Karaoke Mugen's control panel.
`.kara.json` files can be generated from Karaoke Mugen's control panel.
## Database
......@@ -54,21 +56,22 @@ This will take a few minutes depending on your computer's speed.
## Editing/creating new karaoke files
### `.kara` files
### `.kara.json` files
You can go to Karaoke Mugen's control panel to create a new karaoke file. In the `karas` dropdown menu, select "New karaoke" and fill the form.
A faw things to keep in mind :
- Uploaded files will be renamed to fit the Karaoke Mugen naming convention. You don't have to rename them yourself (but you can if you enjoy wasting your time)
- Files will be placed in your primary `karas`, `lyrics`, `series` and `medias` folders. If you have several of those in your `config.yml` only the first one of each will be used to place files.
- Files will be placed in your primary `karas`, `lyrics`, `series`, `tags` and `medias` folders. If you have several of those in your `config.yml` only the first one of each will be used to place files.
- Adding a new karaoke song adds it to your database without you needing to regenerate it, allowing you to test it out at once.
### Manage series
### Manage series and tags
In the `series` menu you can manage series. Add, edit, or remove them.
In the `series` and `tags` menu you can manage series and tags. Add, edit, or remove them.
A few things to keep in mind :
- Editing a series will modify it inside all `.kara` files that contain it.
- Removing a series will remove it from all `.kara` files that contain it.
\ No newline at end of file
- Editing a series or tag will modify it inside all `.kara.json` files that contain it.
- Removing a series or tag will remove it from all `.kara.json` files that contain it.
......@@ -61,3 +61,15 @@ Displays profiling data in console
## `--sql`
Enables SQL logs (in debug)
## `--forceAdminPassword <password>`
Change the admin account's password. Replace `<password>` by what you want to set it to.
## `--updateMedias`
Only updates media files.
## `--noBaseCheck`
Do not check base files on startup. It allows for a faster startup if you're sure your files have not changed.
......@@ -4,7 +4,7 @@ Que vous ayez une suggestion, une demande, ou besoin d'aide, plusieurs moyens po
* Par mail : karaokemugen at shelter.moe
* Par Twitter : [@KaraokeMugen](http://twitter.com/karaokemugen)
* Par Discord : [Canal #karaoke du discord Eden de la Nanami](https://discord.gg/XFXCqzU)
* Par Discord : [Canal #karaoke du discord Eden de la Nanami](http://karaokes.moe/discord)
## Bugs, améliorations...
......
......@@ -4,4 +4,4 @@ L'application possède des "milestones", des points d'étape.
[Consulter les points d'étape de **Karaoke Mugen**](https://lab.shelter.moe/karaokemugen/karaokemugen-app/milestones)
Ces points d'étape permettent de voir quelles fonctionnalités sont attendues dans telle ou telle version. Parfois, une fonctionnalité ou un bug peut être déplacé à un point d'étape ultérieur selon le temps qu'il prend, de quoi il dépend ou si cela représente un gros travail.
\ No newline at end of file
Ces points d'étape permettent de voir quelles fonctionnalités sont attendues dans telle ou telle version. Parfois, une fonctionnalité ou un bug peut être déplacé à un point d'étape ultérieur selon le temps qu'il prend, de quoi il dépend ou si cela représente un gros travail.
......@@ -4,9 +4,11 @@ Si vous n'êtes pas vraiment développeur, que fabriquer un karaoké cétrokompl
Car ce qui fait une bonne base de données, c'est avant tout la richesse de son contenu. Une base de données que l'on peut trier et ausculter sous de nombreux critères est idéale. On a justement [une section entière du site web](http://kara.moe/base) dédiée à cela.
Grâce à ce lien, vous pouvez déjà savoir, par exemple, combien de [chansons en coréen](http://kara.moe/base/languages?p=0&filter=&q=) sont présentes dans la base, ou combien de musiques ont été [composées par Yoko Kanno](http://kara.moe/base/songwriters?p=0&filter=&q=t%3A8120), ou encore combien de karaokés sont [tirés de jeux de la PlayStation première du nom](http://kara.moe/base/tags?p=0&filter=&q=t%3A8120). Et ces informations, pour Karaoké Mugen sont comprises dans les fichiers `.kara`. Nous avons rempli certains d'entre eux avec les données que nous connaissions, mais nous avons de nouveaux fichiers qui arrivent régulièrement (et qui mériteraient d'être mis à jour).
## TODO: Changer ces liens
* Pour compléter les données manquantes, plusieurs possibilités : soit vous signalez ce qu'il manque avec le lien en bas de la fiche d'un karaoké précis et vous priez pour que quelqu'un fasse les modifications pour vous, soit vous modifiez directement les informations dans [le fichier `.kara`](../karafile) avant [de l'uploader](../upload).
Grâce à ce lien, vous pouvez déjà savoir, par exemple, combien de [chansons en coréen](http://kara.moe/base/languages?p=0&filter=&q=) sont présentes dans la base, ou combien de musiques ont été [composées par Yoko Kanno](http://kara.moe/base/songwriters?p=0&filter=&q=t%3A8120), ou encore combien de karaokés sont [tirés de jeux de la PlayStation première du nom](http://kara.moe/base/tags?p=0&filter=&q=t%3A8120). Et ces informations, pour Karaoké Mugen sont comprises dans les fichiers `.kara.json`. Nous avons rempli certains d'entre eux avec les données que nous connaissions, mais nous avons de nouveaux fichiers qui arrivent régulièrement (et qui mériteraient d'être mis à jour).
* Pour compléter les données manquantes, plusieurs possibilités : soit vous signalez ce qu'il manque avec le lien en bas de la fiche d'un karaoké précis et vous priez pour que quelqu'un fasse les modifications pour vous, soit vous modifiez directement les informations dans [le fichier `.kara.json`](../karafile) avant [de l'uploader](../upload).
* Nous avons quelques karaokés en hardsub - c’est à dire où les paroles sont directement incrustées dans la vidéo. On essaye de s’en débarrasser, du coup si vous avez ces [différentes vidéos sans sous-titres](https://lab.shelter.moe/karaokemugen/karaokebase/issues?label_name%5B%5D=hardsub), ce serait un bon début pour nous aider !
* Il y a [quelques karaokés notoirement mal timés](https://lab.shelter.moe/karaokemugen/karaokebase/issues?label_name%5B%5D=mal+tim%C3%A9). C’est-à-dire que les paroles n’apparaissent pas forcément au bon moment pour chanter, ou il en manque, etc. S'il fait déjà partie de la liste vous pouvez [corriger le fichier `.ass`](../karaoke) avant [de l'uploader](../upload). Si ce n'est pas le cas, vous pouvez retrouver [sa fiche](http://kara.moe/base/kara?kid=08066ef4-6ef8-4e53-87a8-6a36c6459605) et utilisez le lien en bas pour nous le signaler !
* On a aussi [des vidéos de très mauvaise qualité](https://lab.shelter.moe/karaokemugen/karaokebase/issues?label_name%5B%5D=mauvaise+qualit%C3%A9), en petite résolution ou autre. Pour ça, il faut parfois chercher loin pour en trouver de meilleures. Et parfois, les gens comme vous en ont déjà des stocks chez eux. N'hésitez pas à nous le signaler si c'est le cas.
......
......@@ -16,8 +16,9 @@ Il est conseillé de suivre les étapes dans l'ordre, excepté pour la section "
* [Réunir le matériel](../material)
* [Réaliser le karaoké en lui-même](../karaoke)
* [Tester votre karaoké](../test)
* [Créer le fichier de métadonnées ".kara"](../karafile)
* [Créer le fichier de métadonnées ".kara.json"](../karafile)
* [Créer le fichier de métadonnées de série ".series.json"](../series)
* [Créer le fichier de métadonnées de tag ".tag.json"](../tag)
* **Partager**
* [Envoyer votre karaoké](../upload)
* [Éditer un karaoké](../editkaraoke)
......
......@@ -32,7 +32,7 @@ Vous souhaitez modifier le karaoké que vous avez fait ? Rien de plus simple :
- Allez dans l'onglet **Karaokes** puis **List**
- Cherchez votre karaoké et appuyez sur le bouton d'édition à droite
- Remplacez la vidéo par la nouvelle en la "drag & droppant" ou en appuyant sur le bouton **Media File** ce qui fera apparaître une boite de dialogue de selection de fichier.
- Enregistrez les modifications en cliquant sur **"Save and generate .kara file"** en bas
- Enregistrez les modifications en cliquant sur **"Save and generate .kara.json file"** en bas
## Modifier les informations d'un karaoké ou d'une série
......@@ -45,11 +45,11 @@ Vous souhaitez modifier le karaoké que vous avez fait ? Rien de plus simple :
- Effectuez vos modifications, supprimez des entrées à l'aide des petites croix sur les étiquettes pour ré-écrire par dessus.
- Enregistrez en cliquant sur **"Save and generate .kara file"** en bas
### Pour une série
### Pour une série ou un tag
- Lancez Karaoke Mugen
- Allez dans **Système**
- Allez dans l'onglet **Series** puis **List**
- Allez dans l'onglet **Series** ou **Tags** puis **List**
- Cherchez votre série et appuyez sur le bouton d'édition à droite
- Effectuez vos modifications, rajoutez des langues et des alias avec `add`, supprimez des entrées à l'aide des petites croix sur les étiquettes pour ré-écrire par dessus
- Enregistrez en cliquant sur **"Save series"** en bas
......
......@@ -2,7 +2,7 @@
## Erreur type "Failed unique constraint KID"
Deux fichiers .kara dans votre base contiennent le même KID. Il s'agit d'un identifiant unique qui doit être **vraiment unique** au sein de votre base de karaokés. Vérifiez les derniers fichiers que vous avez ajoutés / modifiés, et recherchez leur KID dans tous les autres karas (l'outil de recherche de votre OS, ou un simple `grep` peuvent vous aider) pour trouver le coupable.
Deux fichiers .kara.json dans votre base contiennent le même KID. Il s'agit d'un identifiant unique qui doit être **vraiment unique** au sein de votre base de karaokés. Vérifiez les derniers fichiers que vous avez ajoutés / modifiés, et recherchez leur KID dans tous les autres karas (l'outil de recherche de votre OS, ou un simple `grep` peuvent vous aider) pour trouver le coupable.
Cela peut arriver si vous avez repris un .kara existant pour un nouveau karaoké et que vous n'avez pas utilisé le formulaire pour le modifier.
......
- Etiquettes de karaokés
- `TAG_REMIX` : Remix (version alternative des paroles, parodique le plus souvent, ou musique modifiée).
- `TAG_COVER` : Cover (version alternative chantée par quelqu'un)
- `TAG_FANDUB` : Vidéo pour fandub (avec bande rythmo)
- `TAG_PARODY` : Parodie.
- `TAG_HUMOR` : Humour (drôle, 'cule un mouton, vous voyez, quoi...).
- `TAG_R18` : Pour adultes (on sait que vous allez les rechercher tout de suite).
- `TAG_SPOIL` : Spoilers (tout le monde ne sait pas qui est le père de Luke).
- `TAG_LONG` : Chanson estimée longue **(plus de 5 minutes)**.
- `TAG_HARDMODE` : Bonne chance ;) Des chansons durs, très rapides.
- `TAG_DUO` : Chantable à deux (ou plus) personnes.
- Origine
- `TAG_REAL` : Tout ce qui n'est pas animé (avec de vrais acteurs de la vraie vie).
- `TAG_ANIME` : Toute vidéo réalisée avec une technique d'animation de n'importe quelle origine (japonaise, américaine, française, etc).
- `TAG_DRAMA` : Drama.
- `TAG_MOVIE` : Film.
- `TAG_TVSHOW` : Série TV.
- `TAG_SPECIAL` : Épisode spécial.
- `TAG_OVA` : Original Video Animation (série qui n'a pas eu de diffusion TV, mais uniquement sur support VHS / DVD / Blu-Ray).
- `TAG_ONA` : Original Network Animation (webséries, qui n'a été diffusé que sur les interwebs).
- `TAG_VIDEOGAME` : Jeu vidéo.
- `TAG_VN` : Visual Novel.
- `TAG_MOBAGE` : Jeu pour smartphone.
- `TAG_SOUNDONLY` : Pour les times de fichiers audio, qui n'ont qu'une image ou une pochette d'affichée sur le lecteur.
- Classification
- `TAG_VOCALOID` : Vocaloid.
- `TAG_TOKU` : Tokusatsu / Sentai (des oeuvres avec des héros en spandex et des effets spécieux). Va de pair avec le tag "Non-anime".
- `TAG_MECHA` : Anime avec des grorobots.
- `TAG_MAGICALGIRL` : Anime impliquant des filles aux pouvoirs magiques.
- `TAG_IDOL` : Anime avec des filles qui chantent en groupe.
- `TAG_SHOUJO` : Anime visant un public majoritairement féminin.
- `TAG_SHOUNEN` : Anime visant un public majoritairement masculin.
- `TAG_YURI` : Anime impliquant des relations entre filles.
- `TAG_YAOI` : Anime impliquant des relations entre hommes.
- Support (pour les jeux vidéo)
- `TAG_PSX` : PSOne, PlayStation 1.
- `TAG_PS2` : PS2, PlayStation 2.
- `TAG_PS3` : PS3, PlayStation 3.
- `TAG_PS4` : PS4, PlayStation 4.
- `TAG_PSP` : PSP, PlayStation Portable.
- `TAG_PSV` : PSVita, PlayStation Vita.
- `TAG_XBOX360` : XBOX 360.
- `TAG_GAMECUBE` : Nintendo Gamecube.
- `TAG_DS` : Nintendo DS.
- `TAG_3DS` : Nintendo 3DS.
- `TAG_PC` : PC (master race).
- `TAG_SEGACD` : Sega Mega CD.
- `TAG_SATURN` : Sega Saturn (-shiro !).
- `TAG_DREAMCAST` : Sega Dreamcast.
- `TAG_WII` : Nintendo Wii.
- `TAG_SWITCH` : Nintendo Switch.
- `AMV` : Anime Music Video. Montages amateurs autour d'animés.
- S'il s'agit d'une vidéo musicale animée, mais **officielle**, on utilisera plutôt `MV`.
- `CM` : Publicité.
- `ED` : Ending. Générique de fin d'une série.
- `IN` : Insert song. Chanson qui passe en plein milieu d'un épisode.
- `OT` : Other. Autre/inclassable.
- `PV` : Vidéo promotionnelle (trailer, bande-annonce, etc.)
- `LIVE` : Concerts.
- `OP` : Opening. Générique d'ouverture d'une série.
- `MV` : Vidéo musicale (clips musicaux) et vidéos officielles.
# Créer le fichier .kara
# Créer le fichier .kara.json
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.
......@@ -12,7 +12,7 @@ Ici, nous allons voir comment créer ou modifier ce fichier via une interface gr
![ass](../img/creation/System.png)
- Une fois dans la partie système, survolez le 3ème onglet **Karas** puis cliquez sur **New** pour accéder au formulaire de création de .kara.
- Une fois dans la partie système, survolez le 3ème onglet **Karas** puis cliquez sur **New** pour accéder au formulaire de création de .kara.json.
![ass](../img/creation/SystemTab.png)
......@@ -46,10 +46,14 @@ Vous voilà donc dans le formulaire de création de kara.
- `Songwriter(s)` : Le(s) auteur(s), compositeur(s), arrangeur(s) et parolier(s) de votre karaoké. Comme les séries, une liste existe déjà. **Référez-vous [aux normes de typographie plus bas.](../karafile/#typographie)**
- `Creators(s)` : L'entité à l'origine de votre vidéo (souvent des studios d'animation ou de développement de jeux). Comme les séries, une liste existe déjà. Si vous timez une AMV, mettez le studio et le créateur de l'AMV. **Référez-vous [aux normes de typographie plus bas.](../karafile/#typographie)**
- `Karaoke Author(s)` : C'est vous ! Tapez votre nom ou pseudo pour vous ajouter dans la liste des "Karaoke Maker".
- `Tag(s)` : [Se référer à la page dédiée aux définitions des tags.](../references/#tags)
- **À titre d'information et pour éviter les confusions, le tag "Anime" concerne TOUT ce qui est animé, que ça soit un anime japonais, un cartoon américain, une production française, etc. Si votre vidéo n'est pas fait avec une technique d'animation, vous devez donc cocher "Non-anime".** Non-anime correspond à tout ce qui contient majoritairement des prises de vue réelles
- `Tag(s)` : Tags divers à mettre sur votre karaoké
- Si vous avez timé un mp3, vous devez cocher "Sound Only".
- `Families` : Type de famille de karaoké
- **À titre d'information et pour éviter les confusions, le tag "Anime" concerne TOUT ce qui est animé, que ça soit un anime japonais, un cartoon américain, une production française, etc. Si votre vidéo n'est pas fait avec une technique d'animation, vous devez donc cocher "Non-anime".** Non-anime correspond à tout ce qui contient majoritairement des prises de vue réelles
- `Origins` : D'où vient le karaoké
- Le tag "Special" est réservé aux épisodes d'animé notés comme "épisode (TV) spécial".
- `Genres` : Quel genre d'oeuvre est-ce ?
- `Platformes` : Pour les jeux vidéo, sur quelles plate-formes le jeu est-il sorti ?
- `Group(s)` : Permet de regrouper plusieurs kara dans des "familles" pour tout télécharger d'un seul coup via le gestionnaire de téléchargement intégré à Karaoke Mugen. Même en ne rentrant rien, KM ajoutera automatiquement un tag indiquant la décennie d'où vient votre karaoké. La liste complète des groupes existants actuellement [est ici.](https://lab.shelter.moe/karaokemugen/karaokebase/issues/613)
## Pro-tips de remplissage des champs
......
......@@ -14,10 +14,11 @@ Pour lire des données et créer des listes de karaokés, **Karaoke Mugen** a be
Un dossier de base de karaokés contient quatre sous-dossiers, qui s'appellent par défaut :
* `karas` : contient des fichiers `.kara` qui sont les métadonnées sur vos karaokés (nous allons voir comment les créer plus tard).
* `karas` : contient des fichiers `.kara.json` qui sont les métadonnées sur vos karaokés (nous allons voir comment les créer plus tard).
* `lyrics` : contient vos fichiers `.ass`, ce sont eux qui contiennent les paroles.
* `medias` : contient vos fichiers vidéos (`mp4`) ou audio (`mp3`).
* `series` : contient vos fichiers `.series.json` qui renferment la liste des noms alternatifs pour chaque série.
* `tags` : contient vos fichiers `.tag.json` pour toutes les métadonnées que vous avez ajoutées à vos karaokés
Typiquement, dans le dossier `app/data` vous devriez avoir :
......@@ -28,21 +29,22 @@ app
- lyrics
- medias
- series
- tags
```
Ces chemins sont configurables dans le fichier `config.yml`, voir la [section configuration](../../user-guide/configuration) pour plus de détails. Vous pouvez par exemple mettre les vidéos sur un disque externe (plus gros) pendant que l'appli est lancée depuis un disque interne (plus rapide) , si tel est votre souhait.
Une fois que vous avez déposé des fichiers dans votre base, il est temps d'écrire un fichier `.kara`.
## Le fichier .kara
## Le fichier .kara.json
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.
Pour plus d'informations sur la création d'un fichier `.kara` consultez [la documentation](../karafile)
Pour plus d'informations sur la création d'un fichier `.kara.json` consultez [la documentation](../karafile)
## Base de données PostgreSQL
Cette base est créée à partir de vos fichiers `.kara`, `.ass`, `.series.json` et médias.
Cette base est créée à partir de vos fichiers `.kara.json`, `.ass`, `.series.json`, `.tag.json` et médias.
Elle est utilisée par Karaoke Mugen pour pouvoir faire des recherches et accéder à de nombreuses informations sur les karaokés que vous possédez.
......
......@@ -33,16 +33,6 @@ Cette liste doit vous servir comme référentiel, si vous contribuez à une base
[La liste est disponible via ce lien](https://docs.google.com/spreadsheets/d/1ULoVCi7UvTG0qSMVUhnPLOOiehH5jVrVYZMsuYi9O7s/edit#gid=18648527)
## Types
Il s'agit de la liste des types de karaokés que Karaoke Mugen gère :
{!contrib-guide/inc_types.md!}
## Tags
{!contrib-guide/inc_tags.md!}
## Règles de transcription
{!contrib-guide/inc_transcript-rules.md!}
\ No newline at end of file
# Créer ou modifier le fichier des séries
## Modifier la série nouvellement crée avec le .kara
## Modifier la série nouvellement crée avec le .kara.json
Vous venez d'indiquer dans votre fichier `.kara` une nouvelle série qui n'existait pas encore dans la base et vous avez validé le formulaire de remplissage. Maintenant, il faut renseigner d'avantage cette nouvelle série et ajouter ses différents noms et alias.
Vous venez d'indiquer dans votre fichier `.kara.json` une nouvelle série qui n'existait pas encore dans la base et vous avez validé le formulaire de remplissage. Maintenant, il faut renseigner d'avantage cette nouvelle série et ajouter ses différents noms et alias.
### Rechercher sa série
......@@ -10,7 +10,7 @@ Tout d'abord, rendez-vous dans l'onglet **"SYSTÈME"** de Karaoke Mugen puis dan
![img](../img/creation/SeriesList.png)
Là, cherchez la série que vous venez d'ajouter lors de la création du `.kara`, puis cliquez sur son bouton d'édition, sur le côté droit de l'écran.
Là, cherchez la série que vous venez d'ajouter lors de la création du `.kara.json`, puis cliquez sur son bouton d'édition, sur le côté droit de l'écran.
![img](../img/creation/SeriesModif.png)
......
# Créer ou modifier le fichier des tags
La modification ou la création des tags se déroule exactement [comme celle des séries](../series). Merci donc de vous y reporter pour plus de détails.
Les seules différences sont les suivantes :
## Types de tags
Les tags sont des éléments de métadonénes d'un karaoké permettant de mieux l'identifier et d'affiner les recherches et regroupements.
Il existe différents types :
- Chanteurs
- Compositeurs
- Créateurs (studios, entités créatrices)
- Auteurs de karaoké
- Langues
- Types de chanson (Ending, Opening...)
- Groupes (2010s, Mainstream, Génération Club Dorothée...)
- Familles (Anime, Réel, Jeu Vidéo...)
- Origines (Mobage, Série TV, Visual Novel...)
- Genres (Shounen, Shoujo...)
- Plateformes (PS3, PS4, Gamecube...)
- Divers (Difficile, R18...)
Un tag doit apaprtenir à l'une de ses catégories, et peut appartenir à plusieurs catégories (bien souvent chanteur et compositeur, par exemple.)
## Noms courts
Pour certains tags, notamment ceux divers, de plateformes, genres, origines et familles, il faudra indiquer un nom court à trois lettres pour l'interface web de Karaoke Mugen. Par exemple ANI pour Anime, 360 pour XBOX 360, etc.)
# Problèmes récurrents
## Les `.kara`
## Les `.kara.json`
### Les outils
Pour l'instant, les fichiers **.kara** doivent être tous créés et remplis automagiquement par [le formulaire](../karafile) dans l'[interface de gestion](../../user-guide/mgmt-interface). Néanmoins, il peut arriver d'avoir besoin d'ouvrir le fichier en dehors de son interface. Si cela vous arrive, n'hésitez pas à utiliser un éditeur de texte autre que le Bloc-notes de Windows (qui risque de corrompre le fichier).
Les fichiers **.kara.json** doivent être tous créés et remplis automagiquement par [le formulaire](../karafile) dans l'[interface de gestion](../../user-guide/mgmt-interface). Néanmoins, il peut arriver d'avoir besoin d'ouvrir le fichier en dehors de son interface. Si cela vous arrive, n'hésitez pas à utiliser un éditeur de texte autre que le Bloc-notes de Windows (qui risque de corrompre le fichier).
On vous conseille [Notepad++](https://notepad-plus-plus.org/fr/) ou [Sublime Text](https://www.sublimetext.com/).
#### Créer un .kara manuellement
#### Créer un .kara.json manuellement
La [documentation complète](../../dev-guide/kara-content) fait foi pour s'assurer de la validité d'un `.kara`.
La [documentation complète](../../dev-guide/kara-content) fait foi pour s'assurer de la validité d'un `.kara.json`.
Si vous effectuez un *push* vers le dépôt Git de la base Karaoke Mugen, il peut être refusé par le *pipeline* si :
- `mediafile` : n'est pas trouvé dans le FTP de Karaoke Mugen. Il vous faudra donc publier votre vidéo avant de push avec Git. **Attention à l'extension et à la casse.**
- `subfile` : n'est pas trouvé dans la base de Karaoke Mugen.
- `subchecksum` : n'est pas renseigné ou ne correspond pas au fichier dans le dépôt.
- **Tous les champs** de la [documentation complète](../../dev-guide/kara-content) doivent exister dans vos fichiers `.kara` finaux après avoir forcé Karaoke Mugen à générer ses données.
#### La génération de données par Karaoke Mugen
Les champs suivants ne peuvent pas être créés *à la main* et nécessitent donc d'être générés par Karaoke Mugen : `subchecksum`, `KID`, `dateadded`, `datemodif`, `mediasize`, `mediagain`, `mediaduration` et `version`.
Les champs suivants ne peuvent pas être créés *à la main* et nécessitent donc d'être générés par Karaoke Mugen : `subchecksum`, `kID`, `created_at`, `modified_at`, `mediasize`, `mediagain`, `mediaduration` et `version`.
Ces données sont générées dans les `.kara` le nécessitant, à chaque fois que l'application régénère sa base de données. Pour rappel, il y a trois façons de forcer cette régénération :
Ces données sont générées dans les `.kara.json` le nécessitant, à chaque fois que l'application régénère sa base de données. Pour rappel, il y a trois façons de forcer cette régénération :
- **Au lancement de Karaoke Mugen** ce dernier va vérifier que vos fichiers n'ont pas changé. S'ils ont changé, une génération se déclenchera automatiquement.
- **Depuis [l'interface de gestion système](../../user-guide/mgmt-interface)** : dans l'onglet *Database* cliquez sur *Regenerate*
......@@ -32,9 +32,9 @@ Ces données sont générées dans les `.kara` le nécessitant, à chaque fois q
#### Fichier vidéo introuvable alors qu'il est bien là
Vérifiez sur le FTP que le fichier est bien nommé comme dans le `.kara`. Attention aux majuscules et minuscules ! Windows étant insensible à la casse, ça passera, mais pas sous Linux où se trouve le Lab de Shelter. Vérifiez bien que les majuscules et minuscules sont bonnes.
Vérifiez sur le FTP que le fichier est bien nommé comme dans le `.kara.json`. Attention aux majuscules et minuscules ! Windows étant insensible à la casse, ça passera, mais pas sous Linux où se trouve le Lab de Shelter. Vérifiez bien que les majuscules et minuscules sont bonnes.
L'autre possibilité est un caractère parasite invisible, un double espace ou autre. Dans le doute, copiez-collez le nom du fichier à partir du `.kara` lorsque vous renommez le fichier média.
L'autre possibilité est un caractère parasite invisible, un double espace ou autre. Dans le doute, copiez-collez le nom du fichier à partir du `.kara.json` lorsque vous renommez le fichier média.
## Les `.ass`
......
......@@ -2,7 +2,7 @@
## Je ne sais pas utiliser Git
- Vous pouvez passer par [le formulaire d'envoi](https://kara.moe/import). Cette page consiste en la création du `.kara`, avec sa vidéo et son `.ass` en pièce jointe. Le tout sera ensuite envoyé dans une inbox où un membre de l'équipe de mainteneurs se chargera de valider et d'intégrer votre kara dans la base commune. Une issue sera également automatiquement ouverte [ici](https://lab.shelter.moe/karaokemugen/karaokebase/issues?label_name%5B%5D=%C3%A0+int%C3%A9grer), permettant de vous tenir au courant si votre kara a bien été ajouté (l'issue sera alors closed) ou s'il y a des modifications à apporter (en commentaire).
- Vous pouvez passer par [le formulaire d'envoi](https://kara.moe/import). Cette page consiste en la création du `.kara.json`, avec sa vidéo et son `.ass` en pièce jointe. Le tout sera ensuite envoyé dans une inbox où un membre de l'équipe de mainteneurs se chargera de valider et d'intégrer votre kara dans la base commune. Une issue sera également automatiquement ouverte [ici](https://lab.shelter.moe/karaokemugen/karaokebase/issues?label_name%5B%5D=%C3%A0+int%C3%A9grer), permettant de vous tenir au courant si votre kara a bien été ajouté (l'issue sera alors closed) ou s'il y a des modifications à apporter (en commentaire).
- Vous pouvez également passer sur [le Discord](http://karaokes.moe/discord) pour tout nous envoyer à la mano.
......
......@@ -6,4 +6,4 @@ Elle est générée automatiquement à chaque build, veillez à utiliser la docu
[Lire la documentation de l'API](http://mugen.karaokes.moe/apidoc)
L'application envoie également des messages websocket au navigateur du client pour le garder à jour. [Lisez la liste des messages](../websocket) pour savoir à quoi vous attendre.
\ No newline at end of file
L'application envoie également des messages websocket au navigateur du client pour le garder à jour. [Lisez la liste des messages](../websocket) pour savoir à quoi vous attendre.
......@@ -18,6 +18,10 @@
* 7 : les tags divers sont bannis.
* 8 : Le parolier est banni.
* 9 : les groupes de téléchargement sont bannis.
* 10 : les familles de karaokés sont bannis (animes, JV, Real, etc.)
* 11 : les origines d'un karaoké sont bannis (TV Show, mobage, etc.)
* 12 : les genres d'un karaoké sont bannis
* 13 : la plateforme d'un karaoké est bannie (PS4, Vita, DS...)
* 1000 : Le critère de ban s'applique dans le nom des séries. Exemple : `Gundam` va bannir les génériques de `Mobile Suit G Gundam` et ceux de `Gundam SEED`.
* 1001 : Le critère de ban s'applique à un identifiant de karaoké (karaoke ID). Utilisé pour bannir un karaoké spécifique.
* 1002 : Les karaokés de plus de xx secondes sont bannis.
......
......@@ -4,9 +4,86 @@
Voir la documentation sur [la génération des fichiers .kara](../contrib-guide/karafile).
### Version 4
Compatible avec Karaoke Mugen 3.0.0 et supérieur.
Format JSON complètement revu dont voici un exemple :
```JSON
{
"header": {
"version": 4,
"description": "Karaoke Mugen Karaoke Data File"
},
"medias": [
{
"version": "Default",
"filename": "ENG - Portal 2 - PC GAME ED - Want You Gone.mp4",
"audiogain": 1.93,
"filesize": 30578533,
"duration": 145,
"default": true,
"lyrics": [
{
"filename": "ENG - Portal 2 - PC GAME ED - Want You Gone.ass",
"default": true,
"version": "Default",
"subchecksum": "cc116b584fb9097b8246369c45e4f733"
}
]
}
],