Installation

Cette page décrit comment récupérer et installer Karaoke Mugen.

NOTE : Une fois installé, Karaoke Mugen ne nécessite pas de connexion internet, sauf pour certaines fonctionnalités :

L'accès à distance pour le public via l'adresse https://xxxx.kara.moe
Les comptes en ligne
La mise à jour de la base de karaokés au démarrage
La liste des karaokés les plus populaires
La lecture des karaokés qui n'ont pas été téléchargés au préalable

Télécharger Karaoke Mugen

Des exécutables pour Windows et macOS sont disponibles. Vous trouverez soit des installeurs, soit des archives portables.

Si vous n'avez pas déjà téléchargé Karaoke Mugen, consultez la page de téléchargement du site.

Installer Karaoke Mugen

Plusieurs façons d'installer sont possibles, via des versions compilées prêtes à l'emploi ou les sources.

Une fois que c'est fait, vous pouvez passer à la section démarrage rapide

Windows

Deux possibilités :

Installeur : Double-cliquez sur l'exécutable et suivez les instructions.
- Les données de Karaoke Mugen seront stockées à la racine de votre dossier utilisateur (dossier KaraokeMugen)
Archive portable : Décompressez l'archive .zip dans un dossier où vous avez de la place.
- Vous pouvez très bien mettre l'application portable sur une clé usb, toutes les données seront stockées sur celle-ci. C'est utile si vous voulez avoir votre application avec vos playlists de façon nomade.

macOS

Karaoke Mugen n'est pas un logiciel signé, vous devez donc faire clic droit sur l'image DMG, puis Ouvrir. Ensuite, faites glisser Karaoke Mugen dans votre dossier Applications pour l'installer.

Karaoke Mugen fonctionne normalement sur les nouveaux Mac M1 d'Apple.

Linux

Le support Linux, bien que présent, est soumis à de nombreux aléas (chaque distribution et installation Linux est différente). Si vous rencontrez des problèmes, n'hésitez pas à venir nous voir.

Paquet Debian (.deb)

Le paquet Debian installera PostgreSQL, mpv et ffmpeg en dépdendances pour assurer le fonctionnement de Karaoke Mugen, le paquet devrait créer une entrée dans votre menu des applications.

En installant ce paquet Debian, vous devez configurer PostgreSQL correctement, on vous invite à vous rapprocher de la documentation de votre distribution Linux (Ubuntu, Debian, etc.). Pour configurer la base de données Karaoke Mugen, il vous suffit de créer la base de données karaokemugen_app (ou un autre nom) ainsi qu'un rôle pour l'application. Voici la paire de commandes qu'il vous faudra sur les distributions Debian et Ubuntu (cela peut varier selon votre distribution, renseignez vous sur la documentation de votre distribution) :

user$ sudo -iu postgres
postgres$ createuser -P karaokemugen_app
> Un mot de passe vous sera demandé. Mettez celui que vous voulez.
postgres$ createdb karaokemugen_app -O karaokemugen_app -E UTF8
postgres$ psql -c "create extension unaccent;" karaokemugen_app
postgres$ psql -c "create extension pgcrypto;" karaokemugen_app

Après ces commandes, vous allez sans doute devoir configurer Karaoke Mugen pour notamment indiquer le mot de passe que vous avez mis à l'utilisateur karaokemugen_app.

ArchLinux

Il existe deux paquets AUR, karaokemugen et karaokemugen-git. Le premier est basé sur la dernière version en date, le second est basé sur le dernier commit de la branche master. La méthode d'installation reste la même peut importe celui que vous choisissez.

N'importe quel empaqueteur AUR devrait fonctionner, ici nous utiliserons pikaur.

Installation

$ pikaur -S karaokemugen-git

Capture d'écran de Pikaur

L'installation peut prendre du temps selon votre configuration, de 10 à 20 minutes.

Une fois l'installation finie, votre console devrait ressembler à ça :

Capture d'écran de Pikaur, à la fin de l'installation

Si vous voyez ça, c'est que tout s'est bien passé !

Configuration initiale

Comme vous avez pu le lire, le paquet AUR est fourni avec un utilitaire, karaokemugen-install, permettant la configuration automatique de Karaoke Mugen ! Lancez cet utilitaire dès que l'installation est terminée.

$ karaokemugen-install

Attention : comme indiqué au lancement, ce script risque fort de ne pas fonctionner si vous avez changé la configuration de PostgreSQL. Ce script va nécessiter les droits super-utilisateur à plusieurs reprises à l'aide de sudo.

Au lancement, le script vous avertit d'éventuels problèmes qui pourraient empêcher le bon déroulement de l'installation et effectue ensuite toutes les actions nécessaires pour prévoir le fonctionnement de Karaoke Mugen (créer la base de données, appliquer la configuration nécessaire, etc...).

Ce script est interactif, il se peut que le script vous pose quelques questions sur les actions à adopter (notamment si une base de Karaoke Mugen est détectée) ou sur certains éléments de configuration.

Capture d'écran de karaokemugen-install

Une fois le script terminé, vous êtes prêts pour lancer Karaoke Mugen.

Lancement

Bravo ! Votre installation de Karaoke Mugen est désormais prête à être lancée pour vivre de formidables aventures.

Vous devriez pouvoir trouver Karaoke Mugen dans le menu Applications de votre environnement de bureau, si ce n'est pas le cas, lancez simplement karaokemugen dans un terminal.

Capture d'écran du lanceur d'applications

Capture d'écran de l'application Karaoke Mugen

Ça ne marche pas ?

Tout d'abord, désolé, nous voulons que l'installation soit la plus simple possible mais nous ne pouvons pas tout prévoir. N'hésitez pas à venir nous voir si vous avez le moindre souci.

Installer Karaoke Mugen depuis les sources

Vous pouvez installer Karaoke Mugen en téléchargeant son code source.

Téléchargez une version de Karaoke Mugen depuis le dépôt Git via la commande git clone ou via l'archive ZIP correspondante.
- Chaque version est étiquetée (tag) : prenez la version qui vous intéresse.
- Si vous aimez le risque, vous pouvez télécharger la version en cours de développement. Attention, elle contient très probablement des bugs, mais aussi des nouvelles fonctionnalités incroyables, choose your poison !
Téléchargez mpv et placez son exécutable dans le dossier app/bin ou indiquez son chemin dans le fichier de configuration si vous avez déjà mpv d'installé sur votre système.
- Version 0.33 minimum requise
Téléchargez ffmpeg et placez l'exécutable ffmpeg dans le dossier app/bin.
- Version 3.3.1 minimum requise
Téléchargez nodeJS qui est nécessaire pour faire tourner Karaoke Mugen.
- Version 14 requise (actuellement notée LTS).
- Installez nodeJS une fois téléchargé.
Décompressez les sources de Karaoke Mugen dans un dossier de votre disque où il y a de l'espace disque disponible (environ 125 Mo).
Téléchargez la version de PostgreSQL correspondante à votre système.
- Version 10.6 minimum requise. Les versions supérieures fonctionnent (jusqu'à 13.x)
- Soit vous placez le contenu de l'archive des binaires dans app/bin/postgres de façon à avoir un dossier bin, share, lib, etc. dans app/bin/postgres soit vous utilisez votre propre serveur PostgreSQL
- Si vous voulez utiliser votre propre serveur PostgreSQL (ou si vous êtes sur Linux), consultez la partie configuration et créez l'extension unaccent dans votre base de données Karaoke Mugen (par défaut karaokemugen_app). Pour cela connectez-vous avec le super utilisateur postgres à la base de données et lancez la commande CREATE EXTENSION unaccent;

Si vous n'avez pas déjà yarn, consultez le site web pour l'installer sur votre système.

Une fois yarn installé, ouvrez une ligne de commande (cmd, terminal, bash...) et allez dans le dossier où vous avez décompressé les sources de Karaoke Mugen. Lancez alors la commande :

yarn setup

yarn va installer les modules nécessaires au bon fonctionnement de l'application et construire le client React. Cela peut prendre de 1 à 5 minutes selon la rapidité de votre connexion Internet ou de votre machine. Sans accès à Internet, l'installation ne pourra pas continuer.

Vous pouvez répéter les mêmes instructions quand vous mettez à jour votre application, n'oubliez juste pas de transférer le dossier app vers la nouvelle version pour ne pas avoir à recommencer du début.

Une fois que c'est fait, vous pouvez taper yarn start pour démarrer, vous pouvez passer à la section démarrage !

Spécificités selon la plateforme

Linux

Vous aurez besoin de PostgreSQL d'installé et prêt à l'emploi. Consultez la section dédiée à l'installation depuis les sources pour savoir comment le configurer

Linux (Ubuntu)

Attention, la version de mpv fournie dans le dépôt Ubuntu officiel est obsolète, et n'est pas compatible avec Karaoke Mugen.

Il est donc nécessaire d'installer une autre version. Le site officiel fournit plusieurs méthodes d'installation, mais la plus simple pour les distributions basées sur Ubuntu est d'utiliser le PPA :

sudo add-apt-repository ppa:mc3man/mpv-tests
sudo apt-get update
sudo apt-get install mpv

Consultez le site web de mpv pour plus d'informations.

MacOS

Patch

La version fournie avec macOS de Patch est trop ancienne, vous devrez utiliser Homebrew pour l'installer.