Skip to content

Commit 1375c8e

Browse files
committed
Now published to lavalink repo
1 parent ebbd19c commit 1375c8e

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Replace x.y.z with the current version [![](https://jitpack.io/v/DuncteBot/java-
2525
```yaml
2626
lavalink:
2727
plugins:
28-
- dependency: "com.github.DuncteBot.java-timed-lyrics:java-lyrics-plugin:x.y.z"
29-
repository: "https://jitpack.io"
28+
- dependency: "me.duncte123:java-lyrics-plugin:x.y.z"
29+
repository: "https://maven.lavalink.dev/releases" # (optional)
3030
plugins:
3131
lyrics:
3232
countryCode: de #country code for resolving isrc tracks
@@ -88,6 +88,22 @@ plugins:
8888
]
8989
```
9090

91+
## Using in your clients
92+
This plugin comes with a protocol library that allows you to use jackson for deserialization of the JSON.
93+
You can include the library as follows with gradle:
94+
95+
```gradle
96+
repositories {
97+
maven("https://jitpack.io")
98+
}
99+
100+
dependencies {
101+
implementation(group = "com.github.DuncteBot.java-timed-lyrics", name = "protocol", version = "x.y.x")
102+
}
103+
```
104+
105+
replace x.y.x with this version: [![](https://jitpack.io/v/DuncteBot/java-timed-lyrics.svg)](https://jitpack.io/#DuncteBot/java-timed-lyrics)
106+
91107
# Using with lavalyrics
92108

93109
To use this plugin with lavalyrics you need to include a different plugin. Please do not include both the main plugin and the lavalyrics plugin as they will conflict with each other.
@@ -96,8 +112,8 @@ The Yml is as follows:
96112
```yaml
97113
lavalink:
98114
plugins:
99-
- dependency: "com.github.DuncteBot.java-timed-lyrics:lavalyrics:x.y.z"
100-
repository: "https://jitpack.io"
115+
- dependency: "me.duncte123.java-lyrics-plugin:lavalyrics:x.y.z"
116+
repository: "https://maven.lavalink.dev/releases"
101117
plugins:
102118
lyrics:
103119
countryCode: de #country code for resolving isrc tracks

0 commit comments

Comments
 (0)