Skip to content

Commit 1bcc3df

Browse files
authored
Update PLUGINS.md (#924)
1 parent 30bedca commit 1bcc3df

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

PLUGINS.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,20 @@ You can add your own plugin by submitting a pull-request to this file.
2121
## Developing your own plugin
2222

2323
> **Note:**
24-
> If your plugin is developed in Kotlin make sure you are using **Kotlin v1.7.20**
24+
> If your plugin is developed in Kotlin make sure you are using **Kotlin v1.8.22**
2525
26-
Follow these steps to quickly get started with plugin development:
27-
1. Create a copy of https://github.com/lavalink-devs/lavalink-plugin-template
28-
2. Rename the directories `org/example/plugin/` under `src/main/java/` to something more specific like
29-
`io/github/yourusername/yourplugin`
30-
3. Rename `src/main/resources/lavalink-plugins/your-plugin.properties` to the name of your plugin. The file must end
31-
with `.properties`. This is the plugin manifest.
32-
4. Fill out the name, path, and version properties in the manifest. The path is where your classes will be loaded from,
33-
e.g. `io.github.yourusername.yourplugin`.
26+
Follow [these steps](https://github.com/lavalink-devs/lavalink-plugin-template#how-to-use-this-template) to setup a new Lavalink plugin
3427

3528
Now you can start writing your plugin. You can test your plugin against Lavalink by running Gradle with the
36-
`:run` Gradle task. The [Gradle documentation](https://docs.gradle.org/current/userguide/userguide.html) might be helpful.
29+
`:runLavalink` Gradle task. The [Gradle plugin documentation](https://github.com/lavalink-devs/lavalink-gradle-plugin#running-the-plugin) might be helpful.
3730

38-
Lavalink has a [plugin API](plugin-api/src/main/java/dev/arbjerg/lavalink/api) which you can integrate with. The API is
39-
provided as an artifact and is used by the template. It is also possible to integrate with internal parts og Lavalink,
31+
Lavalink has a [plugin API](https://javadoc.io/doc/dev.arbjerg.lavalink/plugin-api/latest/dev/arbjerg/lavalink/api/package-summary.html) which you can integrate with. The API is
32+
provided [as an artifact](https://central.sonatype.com/artifact/dev.arbjerg.lavalink/plugin-api) and is used by the template. It is also possible to integrate with internal parts og Lavalink,
4033
but this is not recommended. Instead, open an issue or pull-request to change the API.
4134

42-
Lavalink is configured by plugins using the Spring Boot framework using Spring annotations. For instance, you could define
43-
an extension to the WebSocket API by exposing a Spring bean like this:
35+
Lavalink is configured by plugins using the Spring Boot framework using Spring annotations.
4436

45-
```java
46-
@Service
47-
class MyExtension implements WebSocketExtension {
48-
// ...
49-
}
50-
```
51-
52-
You can also define custom REST endpoints and configuration file properties. See the Spring Boot documentation for
37+
You can define custom REST endpoints and configuration file properties. See the Spring Boot documentation for
5338
[Spring Web MVC](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web.servlet) and
5439
[type-safe configuration](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#features.external-config.typesafe-configuration-properties).
5540

0 commit comments

Comments
 (0)