Plugins toevoegen aan Lavalink

Plugins voegen bronnen en functies toe aan Lavalink: andere muzieksites, songteksten, zoektypes en meer. Op een node van PlayNHost voeg je er op twee manieren een toe: zet het .jar-bestand van de plugin in de map plugins, of voeg een regel dependency toe aan application.yml en laat Lavalink hem downloaden. Hoe dan ook staan de instellingen onder het onderdeel plugins: van application.yml, en de node moet opnieuw starten.

Wat er al is

Je node start met één plugin: de YouTube-bron, als plugins/youtube-plugin-1.18.2-playnhost1.jar, met zijn instellingen onder plugins:, youtube:. De pluginlijst onder lavalink: is leeg:

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

Voeg de YouTube-plugin niet nog een keer toe, niet als bestand en niet als regel dependency. Een regel dependency ervoor met een andere versie zorgt dat Lavalink het bestand van PlayNHost bij de volgende start verwijdert (de console zegt Deleted ./plugins/youtube-plugin-1.18.2-playnhost1.jar).

Manier 1: het pluginbestand uploaden

Dit werkt ook als de downloadsite van de plugin plat ligt, omdat er bij de start niets wordt gedownload.

1. Download het .jar-bestand van de plugin van zijn eigen releasepagina, meestal op GitHub. Kies een release die voor Lavalink 4 is gemaakt.
2. Stop de node in het panel.
3. Open Files, open de map plugins en upload het .jar-bestand: Je serverbestanden uploaden, bewerken en beheren.
4. Voeg de instellingen van de plugin toe aan application.yml (zie hieronder), sla op en start de node.

Manier 2: een dependency-regel

1. Kopieer de dependency-regel van de plugin van zijn pagina. Hij heeft drie delen: group:name:version.
2. Stop de node, open application.yml onder Files en vervang plugins: [] onder lavalink: door een lijst:

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

3. Gebruik de exacte versie van de pagina van de plugin, en de repository die daar wordt genoemd, als die er is.
4. Sla op en start de node. Lavalink downloadt het bestand bij die start naar plugins en bewaart het.

De instellingen van de plugin

Elke plugin leest zijn eigen blok onder de sleutel plugins: op het hoogste niveau, naast youtube:. Voeg die van jou toe binnen hetzelfde onderdeel plugins:. Een tweede regel plugins: op het hoogste niveau maakt het bestand kapot.

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

application.yml is YAML: spring in met spaties, nooit met tabs, en zet elk niveau twee spaties dieper dan het niveau erboven. Een plugin die sleutels nodig heeft (een account, een client-ID) kan de hele node bij de start stoppen als hij zonder die sleutels aanstaat, dus vul zijn sleutels in of laat hem uit.

Controleer of hij is geladen

Start de node en lees Console. Elke plugin die laadt, drukt vóór de klaarregel een Loaded-regel af. Op een nieuwe node ziet die van de YouTube-plugin er zo uit:

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

Een plugin die je zelf hebt toegevoegd, krijgt een eigen Loaded-regel met zijn bestandsnaam. Een plugin uit een dependency-regel wordt bij de eerste start gedownload en daarna op dezelfde manier geladen.

Stopt de node in plaats daarvan, dan noemt de fout net erboven meestal de plugin of de regel van application.yml die niet klopt: Lavalink-fouten en wat ze betekenen.

Goed om te weten

• Maak een backup voordat je application.yml bewerkt: Backups maken, downloaden en terugzetten.
• Wijzig server.port of plugins.youtube.remoteCipher.url niet: het panel stelt ze allebei bij elke start in.
• Gebruik alleen plugins die je vertrouwt. Een plugin draait in je node met volledige toegang ertoe, inclusief het wachtwoord.
• Sites veranderen wat ze bots laten doen, dus een bronplugin kan een update nodig hebben. Kijk eerst op de releasepagina van de plugin als er een niet meer werkt.
• YouTube heeft een eigen gids: YouTube afspelen op Lavalink 4.