Como adicionar plugins ao Lavalink

Os plugins adicionam fontes e recursos ao Lavalink: outros sites de música, letras, tipos de busca e mais. Em um node da PlayNHost, você adiciona um de duas formas: coloque o arquivo .jar do plugin na pasta plugins, ou adicione uma linha dependency ao application.yml e deixe o Lavalink baixá-lo. De qualquer forma, as configurações dele ficam na seção plugins: do application.yml, e o node precisa ser reiniciado.

O que já existe

Seu node começa com um plugin: a fonte do YouTube, como plugins/youtube-plugin-1.18.2-playnhost1.jar, com as configurações dele em plugins:, youtube:. A lista de plugins em lavalink: está vazia:

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

Não adicione o plugin do YouTube de novo, nem como arquivo nem como linha dependency. Uma linha dependency dele com outra versão faz o Lavalink apagar o arquivo da PlayNHost na próxima inicialização (o console mostra Deleted ./plugins/youtube-plugin-1.18.2-playnhost1.jar).

Jeito 1: enviar o arquivo do plugin

Esse jeito funciona mesmo quando o site de download do plugin está fora do ar, porque nada é baixado ao iniciar.

1. Baixe o .jar do plugin na página de releases dele, geralmente no GitHub. Escolha uma release feita para o Lavalink 4.
2. No painel, pare o node.
3. Abra Files, abra a pasta plugins e envie o .jar: Como enviar, editar e gerenciar os arquivos do seu servidor.
4. Adicione as configurações do plugin ao application.yml (veja abaixo), salve e inicie o node.

Jeito 2: uma linha de dependency

1. Copie a linha de dependency da página do plugin. Ela tem três partes: group:name:version.
2. Pare o node, abra o application.yml em Files e troque plugins: [] em lavalink: por uma lista:

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

3. Use a versão exata da página do plugin e o repository que ela indicar, se houver.
4. Salve e inicie o node. O Lavalink baixa o arquivo para plugins nessa inicialização e o mantém lá.

As configurações do plugin

Cada plugin lê o próprio bloco sob a chave plugins: do nível mais alto, ao lado de youtube:. Adicione o seu dentro da mesma seção plugins:. Uma segunda linha plugins: no nível mais alto quebra o arquivo.

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

O application.yml é YAML: indente com espaços, nunca com tabs, e deixe cada nível dois espaços mais fundo que o de cima. Um plugin que precisa de chaves (uma conta, um client ID) pode parar o node inteiro ao iniciar se for ligado sem elas, então preencha as chaves dele ou deixe-o desligado.

Confira se ele carregou

Inicie o node e leia o Console. Cada plugin que carrega imprime uma linha Loaded antes da linha de pronto. Em um node novo, a do plugin do YouTube é assim:

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

Um plugin que você adicionou ganha a sua própria linha Loaded com o nome do arquivo. Um plugin de uma linha dependency é baixado na primeira inicialização e carregado do mesmo jeito.

Se o node parar em vez disso, o erro logo acima costuma citar o plugin ou a linha do application.yml com problema: Erros do Lavalink e o que significam.

Bom saber

• Faça um backup antes de editar o application.yml: Como criar, baixar e restaurar backups.
• Não mude o server.port nem o plugins.youtube.remoteCipher.url: o painel define os dois a cada inicialização.
• Use apenas plugins em que você confia. Um plugin roda dentro do seu node com acesso total a ele, inclusive à senha.
• Os sites mudam o que deixam os bots fazerem, então um plugin de fonte pode precisar de atualização. Quando um parar de funcionar, confira primeiro a página de releases dele.
• O YouTube tem um guia próprio: Como tocar YouTube no Lavalink 4.