KotStom

Adding as a dependency (Gradle)

First, add the Bladehunt maven repo to the repositories

repositories {
    maven("https://mvn.bladehunt.net/releases")
}

The latest version can be found here.

Module Overview

KotStom

implementation("net.bladehunt:kotstom:<version>")

• Minestom Extensions
  • Tag delegates (by Tag)
  • Scheduler extensions (#await, scheduleTask)
  • Adventure extensions
    • Better text function
    • String.asMini - Converts to MiniMessage. Requires MiniMessage to be in classpath
  • CommandManager extension (Register multiple commands at once)
  • Point extensions
  • Inventory extensions (Inventory#rowSize, get, set)
  • EventNode extensions (Register multiple listeners)
• DSLs
  • Kommand (kommand) - Easier commands w/ delegates
  • Item (item) - Item builder
  • KBar (kbar) - Advanced sidebar
  • Particle (particle) - Particle packet builder
  • Event (listen, buildListener) - Better kotlin support with reified type parameters and better builders
  • Instance (buildInstance) - InstanceContainer builder
• MinecraftServer
  • Each registry and manager has a corresponding inline val
    • e.g. CommandManager means MinecraftServer.getCommandManager()
• Utils
  • EventNodeInventory
    • An inventory with an event node.

adventure-serialization

implementation("net.bladehunt:kotstom-adventure-serialization:<version>")

This module contains an Adventure NBT encoder and decoder.

• Supports polymorphism
• Supports collections
• Usage: AdventureNbt.encodeToCompound, AdventureNbt.decodeFromCompound
  • Initializing your own instance of AdventureNbt can be done using AdventureNbt's constructor

serialization

implementation("net.bladehunt:kotstom-serialization:<version>")

This module contains some kotlinx.serialization serializers for Minestom.

• Adventure
  • KeySerializer
  • SoundSerializer
  • SoundSourceSerializer
  • MiniMessageSerializer
• StaticProtocolObject
  • MaterialSerializer
  • EntityTypeSerializer
  • PotionEffectSerializer
  • NamespaceSerializer
• Point
  • Supports non-content based serialization (Needs a type field)
  • Serial names are the simple names
  • BlockVecSerializer
  • PosSerializer
  • VecSerializer
• UUID
  • StringUuidSerializer (Serializes to string)
  • UuidSerializer (Serializes to most significant/least significant bits)
• Module
  • Note: MiniMessageSerializer is not included in these modules
  • MinestomModule
    • Prefers serializers such as UuidSerializer
  • MinestomConfigModule
    • Prefers more human-readable serializers

extras

Things that shouldn't just be an extension.

implementation("net.bladehunt:kotstom-extras:<version>")

• EventNodeInventory - An inventory with a mapped EventNode
• ReactiveSidebar - A sidebar the uses kotlinx.coroutines. Currently only supports StateFlows.

For more information, visit the wiki or view the example