diff --git a/INSTALLATION.md b/INSTALLATION.md index 28e8414..40307e8 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -2,6 +2,19 @@ Latest version: `2.1.9` +## ProtocolLib + +If you're going to use the ProtocolLib packet adapter, make sure to add ProtocolLib as a `depend` or `softdepend` in your `plugin.yml`: +```yaml +depend: +- ProtocolLib +``` +or +```yaml +softdepend: +- ProtocolLib +``` + ## Gradle ```kotlin @@ -18,22 +31,23 @@ dependencies { // Add packet adapter implementations you want: runtimeOnly("net.megavex:scoreboard-library-modern:$scoreboardLibraryVersion") // 1.17+ runtimeOnly("net.megavex:scoreboard-library-modern:$scoreboardLibraryVersion:mojmap") // Mojang mapped variant (only use if you know what you're doing!) + runtimeOnly("net.megavex:scoreboard-library-protocollib:$scoreboardLibraryVersion") // 1.8+ runtimeOnly("net.megavex:scoreboard-library-packetevents:$scoreboardLibraryVersion") // 1.8+ runtimeOnly("net.megavex:scoreboard-library-v1_8_R3:$scoreboardLibraryVersion") // 1.8 - // If using the PacketEvents implementation, scoreboard-library expects PacketEvents to be in the classpath. + // If using the PacketEvents adapter, scoreboard-library expects PacketEvents to be loaded in the classpath. // Follow either of: // - https://github.com/retrooper/packetevents/wiki/Depending-on-pre%E2%80%90built-PacketEvents // - https://github.com/retrooper/packetevents/wiki/Shading-PacketEvents // Example how to load PacketEvents in your plugin: // https://github.com/retrooper/packetevents-example/blob/24f0c842d47362aef122b794dea29b8fee113fa3/thread-safe-listener/src/main/java/main/Main.java - // If targeting a Minecraft version without native Adventure support, add it as well: + // If targeting a server version without native Adventure support, add it as well: implementation("net.kyori:adventure-platform-bukkit:4.0.1") } ``` -You will need to shade these dependencies and relocate them with something +You will need to shade these dependencies and relocate them using something like [Shadow](https://imperceptiblethoughts.com/shadow/). ## Maven @@ -67,6 +81,12 @@ like [Shadow](https://imperceptiblethoughts.com/shadow/). + + net.megavex + scoreboard-library-protocollib + {VERSION HERE} + runtime + net.megavex scoreboard-library-packetevents @@ -81,7 +101,7 @@ like [Shadow](https://imperceptiblethoughts.com/shadow/).