...
 
Commits (3)
......@@ -40,8 +40,8 @@ If you use your own PostgreSQL server, modify `bundledPostgresBinary` to `false`
General settings are stored here
* `FirstRun` : Set to `false` by Karaoke Mugen to remember it's not the first time the application has been run. If set to false, tutorial won't be triggered, and admin password won't be reset.
* `InstanceID` : This instance's unique identifier.
* `JwtSecret` : Secret identifier used to salt user authentification tokens
* `QuickStart` : Boolean to tell if app should start quickly or not (disables base check)
### Online
......@@ -55,12 +55,26 @@ Online settings are stored here.
- `false` : No data will be sent.
- `true` : Stats will be sent.
* `Host` : Karaoke Mugen Server hostname to connect to for online functionality. This will also replace the URL displayed on the player's screen. By default it's `kara.moe`.
* `IntrosUpdate` : Boolean, defines if intros should be updated from the Shelter gitlab
* `JinglesUpdate` : Boolean, defines if jingles should be updated from the Shelter gitlab
* `Users` : Allows user to create and login online accounts.
- `false` : Users will only able to use local accounts. if an online account is already created on your instance, its name will become `user@something.com`. For example `axel@kara.moe`.
- `true` : Users can connect with their online accounts.
#### Updates
Defines what is going to be automatically updated :
All values are at `true` by default.
* `App` : Checks if an update is available.
##### Medias
* `Intros` : Should intros be updated automatically from Shelter's Gitlab?
* `Jingles` : Same with jingles.
* `Encores` : Same.
* `Outros` : Same.
* `Sponsors` : Same.
### Frontend
Web interface settings
......@@ -124,13 +138,14 @@ Karaoke session specific settings
* `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.
* `JinglesInterval` : Number of songs between jingles. By edfault 20 (this makes about 30 minutes)
* `JinglesInterval` : Number of songs between jingles. By default 20 (this makes about 30 minutes)
* `Private` :
- `false` : Public karaoke. User submissions go to the public playlist.
- `true` : Private karaoke. User submissions go to the current playlist. (by default)
* `Repeat` :
- `false` : Playback stops when reaching the end of the current playlist (by default).
- `true` : Playback continues by looping through the playlist.
* `SponsorsInterval` : Number of songs between sponsors. By default 20 (this makes about 1h20)
* `SmartInsert` :
- `false` : Smart Insert is disabled.
- `true` : Smart Insert is enabled when in `private` mode. this will favor people who haven't added many songs, for example.
......@@ -246,8 +261,6 @@ The Streamer Mode displays poll results during song pauses, and can also allow T
* `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.
* `IntroVideos` : `true` or `false`. On `true`, an intro video song will be played at the beginning of a playlist
* `IntroVideoFile` : Use a specific file as intro instead of picking one at random from the intros folder
#### MysterySongs
......@@ -261,6 +274,28 @@ The Streamer Mode displays poll results during song pauses, and can also allow T
- `false` : Songs added by public are set to mysterious automatically
- `true` : Songs added by public are visible
#### Medias
For every item there are three settings :
* `Enabled` : Enable or disable the media with a boolean.
* `File` : Filename to use for that media during playback. If none is set, KM will select a file at random.
* `Message` : An optional message to display on the screen while the media plays
Medias can be `Intros`, `Outros` and `Encores`. Example :
```YAML
Intros:
Enabled: true
File: PS1-Nanami.mp4
Outros:
Enabled: false
File: Byebye.mp4
Encores:
Enabled: false
File: encoru.mp4
```
### System
......@@ -291,6 +326,9 @@ When searching for a file in these, Karaoke Mugen will go through every entry of
* `Import` : Folder where karaokes can be imported from
* `Jingles` : Folders where to look for jingles.
* `Intros` : Folders where to look for intros.
* `Sponsors` : Folders where to look for sponsors
* `Outros` : Same thing for outros
* `Encores` : ... and encores videos !
* `Karas` : Folders where to look for `.kara` files.
* `Lyrics` : Folders where to look for `.ass` files.
* `Medias` : Folders where to look for media files.
......
......@@ -16,7 +16,7 @@ And voilà, you've recovered your password.
If it's not the first time you're running Karaoke Mugen you can proceed in two ways :
* Use the Security Code found in the console at Karaoke Mugen startup. When logging in, check the "Forgotten password" toggle, and there you'll be able to input the security code and input a new, changed password for the user of your choice.
* Use the Security Code found in the console at Karaoke Mugen startup. When logging in, check the "Forgotten password" toggle if it's an online account and you did specify an email address. A password recovery mail will be sent to you. In case it's a local account or you did not specify an email address, create a new operator account from the login screen. Check the "Operator Account" toggle, and there you'll be able to input the security code and input a new, changed password for the user of your choice.
* 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.
......@@ -31,9 +31,9 @@ If you have a different folder to store your karaokes, so verify the content of
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.
You can also modify those paths from the system interface.
## .kara and .ass files are in place but still nothing happens
## .kara.json and .ass files are in place but still nothing happens
Make sure that you restarted Karaoke Mugen, it should take into account the new files
......@@ -41,7 +41,7 @@ Make sure that you restarted Karaoke Mugen, it should take into account the new
Your graphics card does not support OpenGL. There's an option in the config file to switch to Direct3D under Windows.
If you have a `config.yml` file, open it and add the following : `mpvVideoOutput=direct3d`.
In the system panel, in the configuration menu, find `mpvVideoOutput`in the `Player` section and set it to `direct3d`.
## How much space is needed for Karaoke Mugen?
......@@ -49,13 +49,13 @@ The software should take abotu 200 Mb of disk space, but the karaoke database ca
## Can I download only part of the base?
A Download manager still in Beta is available in the System Control Panel.
A Download manager is available in the System Panel.
## Errors during database generation
### `UNIQUE CONSTRAINT kid failed`
This means you have two .kara files sharing the same KID in your base. KIDs are supposed to be unique, so make sure you don't have a dupe .kara file or a .kara file copied from an existing one where the KID line hasn't been removed.
This means you have two .kara files sharing the same KID in your base. KIDs are supposed to be unique, so make sure you don't have a dupe .kara file or a .kara.json file copied from an existing one where the KID line hasn't been removed.
### `Media file not found`
......
......@@ -69,7 +69,7 @@ d(s) )
18:55:25 - info: [Stats] Sending payload (2.93 kB)
18:55:25 - info: [Stats] Payload data saved locally to logs/statsPayload.json
18:55:25 - info: [Stats] Payload sent successfully
> 18:55:34 - info: [Jingles] Finished updating
18:55:34 - info: [Jingles] Finished updating
```
We can see the software initializes its components. In this example, as it doesn't find any karaoke database, it will create one from your `app/data` folder and what it contains.
......
......@@ -81,3 +81,7 @@ 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.
## `--noPlayer`
Do not start up the player on startup to save some time. The player will be started by KM whenever you'll need it.
......@@ -6,7 +6,9 @@ Karaoke Mugen utilise un fichier de configuration nommé `config.yml` qui se sit
Si ce fichier n'existe pas, il utilise des paramètres par défaut que vous pouvez consulter dans le fichier `config.sample.yml`.
Lorsque vous modifiez un paramètre via l'[interface opérateur](../mgmt-interface), un fichier `config.yml` est écrit (ou modifié s'il existe déjà) avec les nouveaux paramètres, mais tout n'est pas configurable via l'interface web !
Lorsque vous modifiez un paramètre via l'[interface opérateur](../admin-interface), un fichier `config.yml` est écrit (ou modifié s'il existe déjà) avec les nouveaux paramètres, mais tout n'est pas configurable via l'interface opérateur.
Le [panneau système](../mgmt-interface) vous permettra par contre de modifier absolument tous les paramètres dans le menu "Config".
## Base de données
......@@ -44,16 +46,14 @@ Le fichier de configuration étant hiérarchisé, nous allons détailler chaque
Section dédiée aux paramètres généraux.
* `FirstRun` : Passé à `false` par Karaoke Mugen pour indiquer que celui-ci s'est déjà exécuté et que l'utilisateur ne déclenchera pas le tutoriel de nouveau.
* `InstanceID` : L'identifiant aléatoire de votre instance. Cette ligne n'existe pas par défaut dans le fichier `config.sample.yml`.
* `JwtSecret` : Identifiant secret servant à saler les jetons de connexion.
* `QuickStart` : Booléen pour définir si l'app doit faire un démarrage rapide ou non, `false` par défaut.
### Online
Paramètres de configuration des fonctionnalités en ligne.
* `Host` : Nom d'hôte auquel se connecter pour les fonctionnalités en ligne. Cela remplacera aussi l'URL affichée sur l'écran du lecteur. Fixé sur `kara.moe` par défaut.
* `IntrosUpdate` : Booléen, définit si les intros sont mises à jour depuis le Gitlab de Shelter. `true` par défaut.
* `JinglesUpdate` : Booléen, définit si les jingles sont mis à jour depuis le Gitlab de Shelter. `true` par défaut.
* `MediasHost` : Chemin HTTP sur lequel les vidéos se trouvent. Si jamais elles ne sont pas disponibles dans un des dossiers `Medias`, Karaoke Mugen essayera de les lire via cette adresse. Fixé à `undefined` par défaut.
* `Port` : Définit le port du serveur KM Server auquel l'application doit se connecter. Utilisé surtout à des fin de débuggage. `undefined` par défaut.
* `Stats` : Envoi ou non des statistiques d'utilisation de Karaoke Mugen à Karaoke Mugen Server.
......@@ -66,7 +66,22 @@ Paramètres de configuration des fonctionnalités en ligne.
* `Users` : Permet aux utilisateurs de créer ou de se connecter à un compte en ligne.
- `false` : Les utilisateurs ne pourront utiliser que des comptes locaux. Si un compte en ligne a déjà été créé sur l'instance, le nom d'utilisateur deviendra `user@truc.com`. Par exemple `axel@kara.moe`
- `true` : Les utilisateurs peuvent se connecter à leur compte en ligne ou en créer.
* `Updates` : Booléen, définit si l'application doit aller vérifier la présence d'updates sur le Gitlab de Shelter. `true` par défaut.
#### Updates
Définit ce qui va être mis à jour automatiquement :
Toutes les valeurs sont à `true` par défaut.
* `App` : Booléen, vérifie si une nouvelle mise à jour est disponible ou non.
##### Medias
* `Intros` : Booléen, définit si les intros sont mises à jour depuis le Gitlab de Shelter.
* `Jingles` : Booléen, même chose avec les jingles
* `Encores` : Pareil.
* `Outros` : Pareil.
* `Sponsors` : Pareil.
### Frontend
......@@ -133,6 +148,7 @@ Réglages spécifiques à votre session karaoké :
* `Repeat` : Répétition auto de la liste de lecture courante.
- `false` : La lecture s'arrête quand la playlist arrive à la fin (par défaut).
- `true` : La lecture continue en reprenant la playlist depuis le début.
* `SponsorsInterval` : Nombre de chansons entre deux sponsors (par défaut : 50 chansons, ce qui représente peu ou prou 1h20 de karaoké).
* `SmartInsert` :
- `false` : L'insertion intelligente est désactivée.
- `true` : Les karaokés seront intelligemment insérés dans la playlist courante, en favorisant les utilisateurs qui n'ont pas beaucoup ajouté de karaokés, par exemple.
......@@ -242,13 +258,33 @@ Le mode Streamer permet d'afficher les résultats des votes des participants lor
* `AllowDuplicates` : Une chanson peut-elle être ajoutée plusieurs fois (listes non publiques uniquement) ?
* `AllowDuplicateSeries` : Une chanson peut-elle être ajoutée si une autre chanson de la même série ou chanteur est déjà présente ?
* `IntroVideos` : `true` ou `false`. À `true`, une vidéo d'intro sera jouée si on se trouve en tout début de playlist et qu'on lance le karaoké.
* `IntroVideoFile` : Spécifier un fichier d'intro particulier à toujours utiliser plutôt que de piocher aléatoirement dans le dossier.
* `MaxDejaVuTime` : Une chanson est marquée comme "déjà vue" si elle est passée il y a moins de xx minutes (par défaut 60).
* `RemovePublicOnPlay` : Retirer les pistes de la liste publique une fois jouées.
- `false` : Les chansons ne sont pas retirées.
- `true` : Les chansons sont retirées une fois jouées.
#### Medias
Pour chaque élément, il y a trois paramètres :
* `Enabled` : Booléen qui active ou désactive l'utilisation de ce type de média
* `File` : Nom d'un fichier à utiliser pour éviter d'en choisir un aléatoirement.
* `Message` : Un message optionnel à afficher durant la lecture du média.
Les médias sont `Intros`, `Outros` et `Encores`. Exemple :
```YAML
Intros:
Enabled: true
File: PS1-Nanami.mp4
Outros:
Enabled: false
File: Byebye.mp4
Encores:
Enabled: false
File: encoru.mp4
```
#### MysterySongs
* `AddedSongVisibilityAdmin` :
......@@ -287,7 +323,10 @@ Les chemins qui peuvent prendre plusieurs dossiers sont `Backgrounds`, `Jingles`
* `Backgrounds` : Chemins où chercher les fonds d'écran. `app/backgrounds` par défaut.
* `DB` : Chemin vers les fichiers des bases de données.
* `Import` : Chemin de la base pour l'importation de karaokés.
* `Intros` : Chemins où chercher les intros vidéos. `app/intros`par défaut.
* `Intros` : Chemins où chercher les intros vidéos. `app/intros` par défaut.
* `Sponsors` : Chemins où chercher les sponsors. `app/sponsors` par défaut.
* `Outros` : Chemins où chercher les outros. `app/outros` par défaut.
* `Encores` : Chemins où chercher les sponsors. `app/encores` par défaut.
* `Jingles` : Chemins où chercher les jingles vidéo. `app/jingles` par défaut.
* `Karas` : Chemin vers les fichiers `.kara.json`.
* `Lyrics` : Chemin vers les fichiers `.ass`.
......
......@@ -18,7 +18,7 @@ Et voilà, vous avez retrouvé le mot de passe du compte `admin`. En vous connec
Si aucun message n'est affiché, vous avez plusieurs options :
* Repérez dans les logs la mention d'un code de sécurité à 6 chiffres. Sur la fenêtre de connexion, cochez "Mot de passe perdu" et un champ de saisie du code de sécurité s'affichera. Tapez-le, et entrez un nouveau mot de passe avant de valider. Le mot de passe du compte sera modifié!
* Repérez dans les logs la mention d'un code de sécurité à 6 chiffres. Sur la fenêtre de connexion, créez un nouveau compte en cochant "Opérateur" et un champ de saisie du code de sécurité s'affichera. Tapez-le, et vous voilà avec un nouveau compte opérateur. Il est conseillé d'aller dans le panneau système changer le mot de passe de votre réel compte opérateur, puis de vous connecter avec et supprimer celui que vous venez de créer.
* Lancez Karaoke Mugen avec la ligne de commande en ajoutant le paramètre suivant : `--forceAdminPassword <passowrd>``<password>` est le nouveau mot de passe désiré. Vous n'aurez àf aire cela qu'une fois pour le réinitialiser.
## Ma liste de karaokés est vide ou incomplète
......@@ -29,13 +29,13 @@ Si c'est la première fois que vous lancez ce logiciel, il vous affichera les ka
Sinon, si vous avez suivi [le guide de démarrage](../getting-started/#base-de-karaokes), et que vous avez récupéré la base existante, il doit vous afficher les karaokés contenus dans le dossier `app/data`.
Si vous avez un dossier différent pour stocker vos karaokés, alors pensez à vérifier le contenu du fichier `config.yml`. Vous devriez y trouver une ligne `PathMedias = app/data/medias`.
Si vous avez un dossier différent pour stocker vos karaokés, alors pensez à vérifier le contenu du fichier `config.yml`. Vous devriez y trouver une ligne `Medias: app/data/medias`.
Vérifiez que cette ligne indique bien un chemin vers votre répertoire contenant vos fichiers vidéos ou musicaux. Recommencez pour les variables `Karas`, `Subs`, `Tags` et `Series` de `System.Path`.
Vous ne pouvez pas modifier ces chemins depuis l'interface d'administration puisqu'ils sont utilisés au lancement de l'application.
Vous pouvez modifier ces chemins depuis le panneau système, dans le menu Configuration.
## Les .kara et .ass sont en place, mais j'ai toujours rien !
## Les .kara.json et .ass sont en place, mais j'ai toujours rien !
Assurez-vous que :
......@@ -46,7 +46,7 @@ Assurez-vous que :
Le problème est dû à votre carte graphique qui ne gère pas OpenGL. Il y a une option dans le fichier de configuration à modifier pour passer en Direct3D (windows uniquement)
Si vous avez un fichier `config.yml`, ouvrez-le et ajoutez `mpvVideoOutput=direct3d` à la fin.
Editez le paramètre `mpvVideoOutput` qui se trouve dans la section `Player` depuis le panneau système, menu Configuration et indiquez dedans `direct3d`
## J'ai créé moi-même un karaoké, comment je fais pour le partager/l'intégrer à la base publique ?
......@@ -55,7 +55,7 @@ Depuis la version 2.3 de Karaoke Mugen, il existe un formulaire pour ajouter vos
## Combien de place faut-il pour Karaoké Mugen ?
Le logiciel vous prendra dans les 200 Mo avec tous ses fichiers, mais la base de karaokés actuelle pèse plusieurs centaines de giga-octets.
Le logiciel vous prendra dans les 300 Mo avec tous ses fichiers, mais la base de karaokés actuelle pèse plusieurs centaines de giga-octets.
## Peut-on récupérer une partie de la base seulement ?
......
......@@ -69,7 +69,7 @@ d(s) )
18:55:25 - info: [Stats] Sending payload (2.93 kB)
18:55:25 - info: [Stats] Payload data saved locally to logs/statsPayload.json
18:55:25 - info: [Stats] Payload sent successfully
> 18:55:34 - info: [Jingles] Finished updating
18:55:34 - info: [Jingles] Finished updating
```
On y voit que le logiciel initialise les différents composants. Notamment, vérifier si vous avez de nouveaux fichiers dans `app/data` pour mettre à jour sa base de données. Et en dernière étape (en arrière-plan, l'interface web est normalement déjà affichée à ce moment), le logiciel va chercher à mettre à jour ses répertoires `app/intros` et `app/jingles` avant d'envoyer les "payload" de statistiques (s'il y a une connexion à Internet).
......
......@@ -58,6 +58,10 @@ Ne met à jour que les médias, pas les .JSON, ni les .ASS.
Ne vérifie pas au lancement les fichiers de la base de karaokés (afin d'aller plus vite, si vous êtes sûrs que rien n'a changé)
## `--noPlayer`
Ne démarre pas le lecteur vidéo de KM pour gagner un peu de temps au démarrage. Le lecteur sera démarré automatiquement au besoin.
## `--reset`
Réinitialise toutes les données utilisateur. **Attention cela supprimera tous les utilisateurs locaux, les playlists crées, etc.**
......@@ -81,3 +85,4 @@ Restaure un backup de la base de données depuis le fichier `karaokemugen.sql` e
## `--forceAdminPassword <password>`
Change le mot de passe du compte admin. Remplacez `<password>` par le mot de passe souhaité.