Как добавить плагины в Lavalink

Плагины добавляют в Lavalink источники и функции: другие музыкальные сайты, тексты песен, типы поиска и многое другое. На узле PlayNHost плагин добавляется двумя способами: положите .jar-файл плагина в папку plugins или добавьте строку dependency в application.yml, и Lavalink скачает его сам. В обоих случаях настройки плагина указываются в разделе plugins: файла application.yml, а узел нужно перезапустить.

Что уже есть

На вашем узле с самого начала есть один плагин: источник YouTube, файл plugins/youtube-plugin-1.18.2-playnhost1.jar, а его настройки находятся в plugins:, youtube:. Список плагинов в разделе lavalink: пуст:

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

Не добавляйте плагин YouTube второй раз, ни файлом, ни строкой dependency. Строка dependency для него с другой версией заставит Lavalink удалить файл PlayNHost при следующем запуске (в консоли появится Deleted ./plugins/youtube-plugin-1.18.2-playnhost1.jar).

Способ 1: загрузить файл плагина

Это работает, даже если сайт, откуда плагин скачивают, недоступен, потому что при запуске ничего не скачивается.

1. Скачайте .jar плагина со страницы его релизов, обычно на GitHub. Выберите релиз для Lavalink 4.
2. В панели остановите узел.
3. Откройте Files, откройте папку plugins и загрузите .jar: Как загружать, редактировать файлы сервера и управлять ими.
4. Добавьте настройки плагина в application.yml (см. ниже), сохраните и запустите узел.

Способ 2: строка dependency

1. Скопируйте строку dependency плагина с его страницы. В ней три части: group:name:version.
2. Остановите узел, откройте application.yml в Files и замените plugins: [] в разделе lavalink: списком:

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

3. Используйте точную версию со страницы плагина и repository, который там назван, если он есть.
4. Сохраните и запустите узел. Lavalink скачает файл в plugins при этом запуске и сохранит его.

Настройки плагина

Каждый плагин читает свой блок под ключом верхнего уровня plugins:, рядом с youtube:. Добавляйте свой внутрь того же раздела plugins:. Вторая строка plugins: на верхнем уровне ломает файл.

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

application.yml это YAML: делайте отступы пробелами, а не табуляцией, и каждый следующий уровень сдвигайте на два пробела глубже предыдущего. Плагин, которому нужны ключи (аккаунт, client ID), может остановить весь узел при запуске, если его включить без них, поэтому заполните его ключи или оставьте его выключенным.

Проверьте, что плагин загрузился

Запустите узел и прочитайте Console. Каждый плагин, который загрузился, выводит строку Loaded перед строкой о готовности. На новом узле у плагина YouTube она выглядит так:

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

Добавленный вами плагин получает собственную строку Loaded с именем своего файла. Плагин из строки dependency скачивается при первом запуске, а затем загружается так же.

Если вместо этого узел останавливается, ошибка чуть выше обычно называет плагин или строку application.yml, из-за которой это произошло: Ошибки Lavalink и что они означают.

Полезно знать

• Создайте бэкап перед редактированием application.yml: Как создавать, скачивать и восстанавливать бэкапы.
• Не меняйте server.port и plugins.youtube.remoteCipher.url: панель задаёт оба значения при каждом запуске.
• Используйте только плагины, которым доверяете. Плагин работает внутри вашего узла с полным доступом к нему, включая пароль.
• Сайты меняют то, что разрешают ботам, поэтому плагину-источнику может понадобиться обновление. Если плагин перестал работать, сначала проверьте страницу его релизов.
• У YouTube есть своё руководство: Как воспроизводить YouTube в Lavalink 4.