Add migration guide for 1.17

This commit is contained in:
Jakob K
2021-06-15 21:16:12 +02:00
parent 7eca536fa3
commit f2dbb59c4c
2 changed files with 29 additions and 0 deletions

View File

@@ -0,0 +1,27 @@
# Updating from KSpigot for 1.16 to KSpigot for 1.17
## Dependency management
Do **not** use the Gradle shadow plugin anymore! Spigot now has its own library feature, use that one instead. This
applies to KSpigot, but in the best case for your other dependencies as well!
For KSpigot this means, that you have to add the following to your `plugin.yml`:
```yaml
libraries:
- "net.axay:kspigot:VERSION"
```
Of course, replace `VERSION` with the KSpigot version you are using.
Read the setup guide for more information.
## Removed features
You can no longer await anvil input from a player. This feature was not stable enough to fit in this project.
## Changed
The `Listener.register()` extension function now is no longer available, instead it has been replaced
by `SingleListener<T : Event>.register()`. Don't worry, this means that this change does not affect you if you are using
the `listen` function provided by KSpigot.

View File

@@ -40,3 +40,5 @@ nav:
- Item builder: extensions/itembuilder.md
- Gui:
- Compounds: gui/compounds.md
- Migration:
- "1.16 -> 1.17": migration/1_16_to_1_17.md