Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bladehuntmc/kotstom
Kotlinizes Minestom with extension functions & utilities.
https://github.com/bladehuntmc/kotstom
adventure kotlin kotlin-serialization minecraft minestom minestom-library nbt
Last synced: 3 months ago
JSON representation
Kotlinizes Minestom with extension functions & utilities.
- Host: GitHub
- URL: https://github.com/bladehuntmc/kotstom
- Owner: bladehuntmc
- License: mit
- Created: 2024-07-01T03:57:27.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T12:26:56.000Z (5 months ago)
- Last Synced: 2024-09-11T18:34:03.177Z (5 months ago)
- Topics: adventure, kotlin, kotlin-serialization, minecraft, minestom, minestom-library, nbt
- Language: Kotlin
- Homepage:
- Size: 1010 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 
KotStom
---
### Adding as a dependency (Gradle)
First, add the Bladehunt maven repo to the repositories
```kotlin
repositories {
maven("https://mvn.bladehunt.net/releases")
}
```
The latest version can be found [here](https://mvn.bladehunt.net/#/releases/net/bladehunt/kotstom).
## Module Overview
### KotStom
```kotlin
implementation("net.bladehunt:kotstom:")
```
- 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
```kotlin
implementation("net.bladehunt:kotstom-adventure-serialization:")
```
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
```kotlin
implementation("net.bladehunt:kotstom-serialization:")
```
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.
```kotlin
implementation("net.bladehunt:kotstom-extras:")
```
- EventNodeInventory - An inventory with a mapped EventNode
- ReactiveSidebar - A sidebar the uses kotlinx.coroutines. Currently only supports StateFlows.
### For more information, visit [the wiki](https://www.bladehunt.net/developers/kotstom) or view [the example](example/src/main/kotlin)