Skip to content

Commit

Permalink
Now published to lavalink repo
Browse files Browse the repository at this point in the history
  • Loading branch information
duncte123 committed Jan 4, 2024
1 parent ebbd19c commit 1375c8e
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Replace x.y.z with the current version [![](https://jitpack.io/v/DuncteBot/java-
```yaml
lavalink:
plugins:
- dependency: "com.github.DuncteBot.java-timed-lyrics:java-lyrics-plugin:x.y.z"
repository: "https://jitpack.io"
- dependency: "me.duncte123:java-lyrics-plugin:x.y.z"
repository: "https://maven.lavalink.dev/releases" # (optional)
plugins:
lyrics:
countryCode: de #country code for resolving isrc tracks
Expand Down Expand Up @@ -88,6 +88,22 @@ plugins:
]
```

## Using in your clients
This plugin comes with a protocol library that allows you to use jackson for deserialization of the JSON.
You can include the library as follows with gradle:

```gradle
repositories {
maven("https://jitpack.io")
}
dependencies {
implementation(group = "com.github.DuncteBot.java-timed-lyrics", name = "protocol", version = "x.y.x")
}
```

replace x.y.x with this version: [![](https://jitpack.io/v/DuncteBot/java-timed-lyrics.svg)](https://jitpack.io/#DuncteBot/java-timed-lyrics)

# Using with lavalyrics

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.
Expand All @@ -96,8 +112,8 @@ The Yml is as follows:
```yaml
lavalink:
plugins:
- dependency: "com.github.DuncteBot.java-timed-lyrics:lavalyrics:x.y.z"
repository: "https://jitpack.io"
- dependency: "me.duncte123.java-lyrics-plugin:lavalyrics:x.y.z"
repository: "https://maven.lavalink.dev/releases"
plugins:
lyrics:
countryCode: de #country code for resolving isrc tracks
Expand Down

0 comments on commit 1375c8e

Please sign in to comment.