Come aggiungere plugin a Lavalink

I plugin aggiungono fonti e funzioni a Lavalink: altri siti musicali, testi dei brani, tipi di ricerca e altro. Su un nodo PlayNHost ne aggiungi uno in due modi: metti il file .jar del plugin nella cartella plugins, oppure aggiungi una riga dependency in application.yml e lascia che Lavalink lo scarichi. In entrambi i casi le sue impostazioni vanno nella sezione plugins: di application.yml e il nodo ha bisogno di un riavvio.

Cosa c'è già

Il tuo nodo parte con un plugin: la fonte YouTube, come plugins/youtube-plugin-1.18.2-playnhost1.jar, con le sue impostazioni sotto plugins:, youtube:. L'elenco dei plugin sotto lavalink: è vuoto:

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

Non aggiungere di nuovo il plugin YouTube, né come file né come riga dependency. Una riga dependency per questo plugin con un'altra versione fa sì che Lavalink elimini il file di PlayNHost al successivo avvio (la console dice Deleted ./plugins/youtube-plugin-1.18.2-playnhost1.jar).

Modo 1: carica il file del plugin

Funziona anche quando il sito da cui si scarica il plugin non è raggiungibile, perché all'avvio non viene scaricato nulla.

1. Scarica il .jar del plugin dalla sua pagina delle release, di solito su GitHub. Scegli una release fatta per Lavalink 4.
2. Nel pannello, ferma il nodo.
3. Apri Files, apri la cartella plugins e carica il .jar: Come caricare, modificare e gestire i file del tuo server.
4. Aggiungi le impostazioni del plugin a application.yml (vedi sotto), salva e avvia il nodo.

Modo 2: una riga dependency

1. Copia la riga dependency del plugin dalla sua pagina. Ha tre parti: group:name:version.
2. Ferma il nodo, apri application.yml in Files e sostituisci plugins: [] sotto lavalink: con un elenco:

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

3. Usa la versione esatta indicata nella pagina del plugin e il repository che indica, se ce n'è uno.
4. Salva e avvia il nodo. Lavalink scarica il file nella cartella plugins a quell'avvio e lo conserva.

Le impostazioni del plugin

Ogni plugin legge il proprio blocco sotto la chiave plugins: di primo livello, accanto a youtube:. Aggiungi il tuo dentro la stessa sezione plugins:. Una seconda riga plugins: al primo livello rompe il file.

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

application.yml è YAML: indenta con gli spazi, mai con i tab, e tieni ogni livello due spazi più a destra di quello sopra. Un plugin che richiede delle chiavi (un account, un client ID) può fermare l'intero nodo all'avvio se è attivo senza di esse, quindi compila le sue chiavi oppure lascialo disattivato.

Controlla che si sia caricato

Avvia il nodo e leggi Console. Ogni plugin che si carica stampa una riga Loaded prima della riga di pronto. Su un nodo nuovo, quella del plugin YouTube è fatta così:

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

Un plugin che hai aggiunto ha la sua riga Loaded con il nome del file. Un plugin da una riga dependency viene scaricato al primo avvio e poi caricato allo stesso modo.

Se invece il nodo si ferma, l'errore subito sopra di solito nomina il plugin o la riga di application.yml che sbaglia: Errori Lavalink e cosa significano.

Da sapere

• Fai un backup prima di modificare application.yml: Come creare, scaricare e ripristinare i backup.
• Non cambiare server.port né plugins.youtube.remoteCipher.url: il pannello imposta entrambi a ogni avvio.
• Usa solo plugin di cui ti fidi. Un plugin gira dentro il tuo nodo con pieno accesso, password compresa.
• I siti cambiano ciò che lasciano fare ai bot, quindi un plugin di una fonte può aver bisogno di un aggiornamento. Quando uno smette di funzionare, controlla prima la pagina delle release del plugin.
• YouTube ha una guida tutta sua: Come riprodurre YouTube su Lavalink 4.