Add 1.18 migration guide

This commit is contained in:
Jakob K
2021-12-12 03:47:51 +01:00
parent 73ddd73c27
commit 69d9be0af8
2 changed files with 44 additions and 1 deletions

View File

@@ -0,0 +1,42 @@
# Upgrading to KSpigot for 1.18 (from 1.17)
## Use it with paperweight (really (like really))
Please use this library together with the paperweight Gradle plugin, as it remaps the obfuscated parts of the KSpigot
jar to mojmap, and adds all necessary dependencies with one bundle!
`settings.gradle.kts`
```kt
pluginManagement {
repositories {
gradlePluginPortal()
maven("https://papermc.io/repo/repository/maven-public/")
}
}
```
`build.gradle.kts`
```kt
plugins {
id("io.papermc.paperweight.userdev") version "VERSION"
}
dependencies {
paperDevBundle("1.18.1-R0.1-SNAPSHOT")
implementation("net.axay:kspigot:1.18.0")
}
```
## Removed features
The wrapper for nbt compounds has been removed, use `CompoundTag` of net.minecraft instead!
## Upcoming features
Due to paper now being binary compatible with all other Minecraft modding toolchains, expect to see features
from [FabrikMC](https://jakobkmar.github.io/fabrikmc/) on the paper side!
## Paper first policy
From now on, KSpigot **only supports Paper**. Use it with "vanilla" Spigot at your own risk. It is highly suggested that you
use Paper together with this library.

View File

@@ -47,4 +47,5 @@ nav:
- Brigardier: commands/brigardier.md
- Brigardier example: commands/brigardier_example.md
- Migration:
- "1.16 -> 1.17": migration/1_16_to_1_17.md
- "1.17 to 1.18": migration/1_17_to_1_18.md
- "1.16 to 1.17": migration/1_16_to_1_17.md