Kytale

Kotlin framework for Hytale server plugin development.

Kytale bundles the Kotlin runtime and provides idiomatic DSLs to build plugins, gameplay systems, UI, commands, events, configuration, and more - all with first-class Kotlin support.

Source & Full Documentation: https://github.com/briarss/Kytale/tree/main

Features

• Kotlin Runtime - stdlib, reflect, coroutines (2.2.0), kotlinx.serialization
• Event DSL - Type-safe event subscriptions with reified generics
• Command DSL - Structured commands with async / coroutine support
• Config DSL - JSON configuration via property delegates
• Scheduler DSL - Coroutine-based task scheduling
• UI DSL - Compile-time UI generation and interactive elements
• Hexweave (Optional) - Helper layer for player events, commands, tasks, and ECS systems
• Extension Functions - Utilities for entities, vectors, velocity, targeting, and damage

Quick Start

Gradle Setup

Add Kytale to your build.gradle.kts:

plugins {
    kotlin("jvm") version "2.2.0"
    kotlin("plugin.serialization") version "2.2.0"
    id("hytale-mod") version "0.+"
}

repositories {
    mavenCentral()
    maven("https://cursemaven.com")
    maven("https://maven.hytale-modding.info/releases")
}

dependencies {
    compileOnly("curse.maven:kytale-PROJECTID:FILEID")
}
````

---

### Runtime Dependency

Add Kytale as a dependency in your `manifest.json`:

```json
{
  "Dependencies": {
    "AmoAster:Kytale": "*"
  }
}

Example Plugin

class MyPlugin(init: JavaPluginInit) : KotlinPlugin(init) {

    override fun setup() {
        super.setup()

        // Register events
        event<PlayerConnectEvent> { event ->
            logger.info { "Player connected: ${event.playerRef.uuid}" }
        }

        // Register commands
        command("greet", "Greet the player") {
            executes { ctx ->
                ctx.sendMessage(Message.raw("Hello!"))
            }
        }
    }
}

Plugin Lifecycle

1. Constructor - Basic initialization
2. setup() - Register events, commands, UI, and systems
3. start() - Post-setup initialization (all plugins loaded)
4. shutdown() - Cleanup on unload

Learn More

Full documentation, advanced DSL usage, UI system details, Hexweave, and development setup are available on GitHub:

https://github.com/briarss/Kytale/tree/main

License

MIT License