Envoyer votre karaoké

Je ne sais pas utiliser Git

  • Vous pouvez passer par le formulaire d'envoi.
  • Ce formulaire accepte les fichiers karaoké au format ASS (conseillé), Ultrastar (txt), KAR, Karafun (kfn) ou Epitanime Toyunda v1 à v3 (txt). Pour tout autre format que ASS, le fichier de karaoké sera converti automatiquement.
  • Cette page consiste en la création du .kara.json, avec son média et son .ass en pièce jointe. Le tout sera ensuite envoyé dans une boîte de réception où un membre de l'équipe de mainteneurs se chargera de valider et d'intégrer votre karaoké dans la base commune.
  • Une issue sera également automatiquement ouverte ici, permettant de vous tenir au courant si votre kara a bien été ajouté (l'issue sera alors fermée) ou s'il y a des modifications à apporter (en commentaire).
  • Vous pouvez également passer sur le Discord pour tout nous envoyer à la mano.

Je ne sais pas utiliser Git, mais je veux bien apprendre

Git est un logiciel de gestion de versions. C'est l'outil le plus adapté pour gérer une base de données comme celle-ci, car il permet d'avoir un journal de qui à modifié quoi, quand, et d'être absolument certain d'avoir exactement la même base de karaokés que quelqu'un d'autre.

Chaque modification est archivée et peut être retrouvée. À tout moment, on peut également revenir en arrière si l'on s'aperçoit qu'on a fait une bêtise. Plus d'infos :

Passez sur Discord (dans le canal #karaoke) et nous verrons comment faire pour ajouter vos karaokés. L'utilisation de git est cependant recommandée. Nous avons conscience que tout le monde n'a pas le temps de s'investir.

Je sais utiliser git

Selon qui vous êtes les choses ne vont pas se passer de la même façon :

Vous n'êtes pas (encore) dans l'équipe de mainteneurs de Karaoke Mugen

Vous ne souhaitez pas forcément vous investir plus que ça, mais vous voulez quand même contribuer.

Sur la page git de la base, utilisez le bouton Fourcher/Fork pour créer votre propre version de la base et travailler dedans.

Une fois que vous aurez ajouté votre fichier .kara et son fichier .ass à votre base, faites une pull request pour la faire ajouter à la base principale (et envoyez un lien vers la vidéo de votre karaoké dans le message de PR)

Vous êtes déjà mainteneur

Les mainteneurs bénéficient d'un accès au dépôt git de la base ainsi qu'au FTP avec les vidéos. Pour devenir mainteneur, il suffit de le demander sur Discord !

  • Uploadez vos vidéos sur Shelter ou renommez-les s'il s'agit simplement d'un changement de nom.
  • Ne pushez vos commits qu'une fois les vidéos bien en place !

Que vous soyez l'un ou l'autre

Vous devez avoir un espace de travail similaire aux autres. La marche à suivre est :

  • Clonez le dépôt Git chez vous.
  • Placez les vidéos au bon endroit (dans app/data/videos, quoi). Si vous n'avez pas le temps/la place nécessaire pour stocker toutes les vidéos, ne paniquez pas : leur absence n'empêchera pas Karaoke Mugen de fonctionner.
  • Faites vos modifs, ou ajoutez vos karaokés et assurez-vous que le .kara pointe bien sur les bons fichiers.
  • Configurez Karaoke Mugen pour utiliser votre dépôt local git avec ses vidéos et générez une nouvelle base. Le lancement du logiciel devrait suffire : si Karaoke Mugen détecte de nouveaux fichiers, il regénérera la base de données pour vous.
  • Si la génération ne retourne aucune erreur alors vous pouvez continuer, sinon vérifiez vos fichiers selon la nature de l'erreur.
  • Faites votre commit sous git une fois que vous êtes satisfait ou envoyez-nous les fichiers .kara.json, .ass et éventuellement les .tag.json nécessaires sur Discord (avec un lien vers la vidéo).

Dans le cas d'un commit sur le git :

  • S'il s'agit d'un ajout de kara, précisez dans le message de commit le nom complet du ou des karas. Cela permet d'ensuite mieux voir quels ajouts ont été faits.
  • Une fois le commit effectué, pushez votre modification !
  • Une série de tests automatique est effectuée par le Lab pour vérifier si votre modification est bonne. Si ce n'est pas le cas, un message d'erreur s'affichera sur Discord dans le canal #karaoke. Vous pouvez également consulter les derniers pipelines pour voir si le test s'est bien passé ou pas.
    • Si le test ne s'est pas bien passé, ne paniquez pas : quelqu'un vous aidera à y voir plus clair dans le message d'erreur affiché via la console du pipeline.
    • Corrigez l'erreur ou demandez à quelqu'un de la corriger pour vous si vous ne comprenez pas/n'avez pas le temps.
    • Relancez le pipeline ou faites un autre commit.