Een Minecraft-plugin maken in Kotlin

Stap voor stap

1. 1.Maak een Gradle-project met Kotlin DSL

   Een build.gradle.kts met de plugin kotlin("jvm"), een Java-toolchain die bij je Minecraft-versie past (17, 21 of 25) en de PaperMC-repository.

2. 2.Voeg de server-API toe

   compileOnly("io.papermc.paper:paper-api:<version>"). Net als bij Java levert de server die tijdens het draaien, dus hij wordt nooit meegebundeld.

3. 3.Schrijf de hoofdklasse

   class MyPlugin : JavaPlugin() met override fun onEnable(). Registreer commando's en listeners precies zoals in Java.

4. 4.Breng de Kotlin-standaardbibliotheek mee

   Bundel hem in de .jar met de Shadow-plugin, of laat de server hem bij het opstarten downloaden via de lijst libraries in plugin.yml. Zonder een van beide faalt de plugin met NoClassDefFoundError: kotlin/....

5. 5.Schrijf plugin.yml

   Hetzelfde bestand als bij een Java-plugin: naam, versie, main (de Kotlin-klasse), api-version, commando's en permissies.

6. 6.Bouwen en testen

   ./gradlew shadowJar (of build), kopieer de .jar uit build/libs/ naar een testserver en lees de console bij het opstarten.

Kotlin op de server krijgen

• Shade hem: de Shadow-plugin voor Gradle kopieert de Kotlin-standaardbibliotheek en andere runtimebibliotheken in je .jar. Het werkt op elke versie en is de meest gekozen aanpak.
• libraries in plugin.yml: vanaf Spigot 1.16.5 kan een plugin bibliotheken van Maven Central opgeven die de server voor hem downloadt en laadt. De .jar blijft klein, maar de server heeft bij de eerste start internettoegang nodig.
• Bibliotheken die je toevoegt: kotlinx-coroutines is een aparte bibliotheek, geen onderdeel van de standaardbibliotheek, en moet ook worden meegebundeld. Door hem naar je eigen package te relocaten voorkom je conflicten met andere plugins die een andere versie bundelen.

Coroutines en de main thread

Coroutines zijn een nette manier om data uit een database te laden zonder dat de server bevriest, maar de Bukkit-API (werelden, entity's, inventories) moet nog steeds vanaf de main thread worden gebruikt. Doe het trage werk op een achtergronddispatcher en schakel dan met de scheduler terug naar de serverthread voordat je de game aanraakt. Koppel de coroutine scope aan de plugin, zodat hij in onDisable() wordt geannuleerd.

Java of Kotlin?

Met Codexe

Kies Bukkit/Spigot/Paper (Kotlin). Codexe genereert een Gradle-project met build.gradle.kts, de Paper-API, de Shadow-plugin om te bundelen wat de server niet levert, en coroutines meegebundeld en gerelocated als de code ze gebruikt. De plugin wordt gecompileerd voordat hij Klaar is, en Kotlin-plugins kun je net als Java-plugins op een testserver proberen en laten controleren door testspelers. Zie de Kotlin-plugingenerator.

"Een Paper 1.21.4-plugin in Kotlin genaamd Bounties: /bounty set <player> <amount> via Vault, de moordenaar krijgt de beloning, /bounty top toont de 10 hoogste, opgeslagen in SQLite met coroutines voor databasetoegang. Gebruik data classes en extension functions, houd de aanroepen van de Bukkit-API op de main thread."

Vragen