Comment ajouter des plugins à Lavalink

Les plugins ajoutent des sources et des fonctions à Lavalink : d’autres sites de musique, les paroles, des types de recherche et plus encore. Sur un node PlayNHost, vous en ajoutez un de deux façons : déposer le fichier .jar du plugin dans le dossier plugins, ou ajouter une ligne dependency à application.yml et laisser Lavalink le télécharger. Dans les deux cas, ses paramètres vont dans la section plugins: de application.yml, et le node doit être redémarré.

Ce qui est déjà là

Votre node démarre avec un plugin : la source YouTube, sous la forme plugins/youtube-plugin-1.18.2-playnhost1.jar, avec ses paramètres sous plugins:, youtube:. La liste des plugins sous lavalink: est vide :

lavalink:
  plugins: []
  pluginsDir: "./plugins"

N’ajoutez pas le plugin YouTube une seconde fois, ni comme fichier ni comme ligne dependency. Une ligne dependency pour lui avec une autre version fait que Lavalink supprime le fichier PlayNHost au démarrage suivant (la console affiche Deleted ./plugins/youtube-plugin-1.18.2-playnhost1.jar).

Méthode 1 : téléverser le fichier du plugin

Cela marche même quand le site de téléchargement du plugin est en panne, car rien n’est téléchargé au démarrage.

1. Téléchargez le .jar du plugin depuis sa propre page de releases, en général sur GitHub. Choisissez une version faite pour Lavalink 4.
2. Dans le panel, arrêtez le node.
3. Ouvrez Files, ouvrez le dossier plugins et téléversez le .jar : Comment téléverser, modifier et gérer les fichiers de votre serveur.
4. Ajoutez les paramètres du plugin à application.yml (voir plus bas), enregistrez, puis démarrez le node.

Méthode 2 : une ligne dependency

1. Copiez la ligne dependency du plugin depuis sa page. Elle a trois parties : group:name:version.
2. Arrêtez le node, ouvrez application.yml dans Files, et remplacez plugins: [] sous lavalink: par une liste :

lavalink:
  plugins:
    - dependency: "com.github.topi314.lavasrc:lavasrc-plugin:VERSION"
      repository: "https://maven.lavalink.dev/releases"
  pluginsDir: "./plugins"

3. Utilisez la version exacte indiquée sur la page du plugin, et le repository qu’elle nomme, s’il y en a un.
4. Enregistrez et démarrez le node. Lavalink télécharge le fichier dans plugins à ce démarrage et le garde.

Les paramètres du plugin

Chaque plugin lit son propre bloc sous la clé plugins: de premier niveau, à côté de youtube:. Ajoutez le vôtre dans cette même section plugins:. Une deuxième ligne plugins: au premier niveau casse le fichier.

plugins:
  youtube:
    enabled: true
    # ... leave the YouTube lines as they are
  lavasrc:
    sources:
      spotify: false

application.yml est du YAML : indentez avec des espaces, jamais des tabulations, et gardez chaque niveau deux espaces plus loin que celui du dessus. Un plugin qui a besoin de clés (un compte, un client ID) peut arrêter tout le node au démarrage s’il est activé sans elles : remplissez donc ses clés ou laissez-le désactivé.

Vérifier qu’il est chargé

Démarrez le node et lisez la Console. Chaque plugin qui se charge affiche une ligne Loaded avant la ligne « ready ». Sur un nouveau node, celle du plugin YouTube ressemble à ceci :

Loaded 'youtube-plugin-1.18.2-playnhost1.jar' (17 classes)
Lavalink is ready to accept connections.

Un plugin que vous avez ajouté a sa propre ligne Loaded avec le nom de son fichier. Un plugin issu d’une ligne dependency est téléchargé au premier démarrage, puis chargé de la même façon.

Si le node s’arrête à la place, l’erreur juste au-dessus nomme en général le plugin ou la ligne de application.yml en cause : Erreurs Lavalink et leur signification.

Bon à savoir

• Faites un backup avant de modifier application.yml : Comment créer, télécharger et restaurer des backups.
• Ne changez pas server.port ni plugins.youtube.remoteCipher.url : le panel définit les deux à chaque démarrage.
• N’utilisez que des plugins en lesquels vous avez confiance. Un plugin s’exécute à l’intérieur de votre node avec un accès complet à celui-ci, mot de passe compris.
• Les sites changent ce qu’ils laissent faire aux bots : un plugin de source peut donc avoir besoin d’une mise à jour. Consultez d’abord la page de releases du plugin quand l’un d’eux cesse de fonctionner.
• YouTube a son propre guide : Comment lire YouTube sur Lavalink 4.