Make your own plugin¶
Note:
If your plugin is developed in Kotlin make sure you are using Kotlin v1.8.22
Follow these steps to setup a new Lavalink plugin
Now you can start writing your plugin. You can test your plugin against Lavalink by running Gradle with the
:runLavalink Gradle task. The Gradle plugin documentation might be helpful.
Lavalink has a plugin API which you can integrate with. The API is provided as an artifact and is used by the template. It is also possible to integrate with internal parts og Lavalink, but this is not recommended. Instead, open an issue or pull-request to change the API.
Lavalink is configured by plugins using the Spring Boot framework using Spring annotations.
You can define custom REST endpoints and configuration file properties. See the Spring Boot documentation for Spring Web MVC and type-safe configuration.
If you simply want to add a Lavaplayer AudioSourceManager to Lavalink it is sufficient to simply provide it as a bean.
For example:
import org.springframework.stereotype.Service;
@Service
class MyAudioSourceManager implements AudioSourceManager {
// ...
}
Likewise, you can also add new MediaContainerProbe this way, to be used with the HTTP and local sources:
import org.springframework.stereotype.Service;
@Service
class MyMediaContainerProbe implements MediaContainerProbe {
// ...
}
To intercept and modify existing REST endpoints, you can implement the RestInterceptor interface:
import org.springframework.stereotype.Service;
import dev.arbjerg.lavalink.api.RestInterceptor;
@Service
class TestRequestInterceptor implements RestInterceptor {
// ...
}
To add custom info to track and playlist JSON, you can implement the AudioPluginInfoModifier interface:
import org.springframework.stereotype.Service;
import dev.arbjerg.lavalink.api.AudioPluginInfoModifier;
@Service
class TestAudioPluginInfoModifier implements AudioPluginInfoModifier {
// ...
}