mcutils

A Kotlin multiplatform library provides utility functions for Minecraft-related queries.

Installation

implementation("tech.aliorpse:mcutils:$version")

Tip

Make sure to include a Ktor client engine, such as ktor-client-cio.

Features

Server List Ping

runBlocking {
    var status
    status = MCServer.getStatus("mc.hypixel.net")
    
    status = MCServer.getStatus(
        host = "wdsj.net",
        port = 25565,
        enableSrv = false
    )
}

Remote Console

runBlocking {
    val connection = MCServer.createRconConnection("localhost", password = "mcutilsTest")
    connection.use { println(it.execute("help")) }
}

Query

runBlocking {
    val result = MCServer.getQueryFull("wdsj.net")
    println(result)
}

Player Profile

runBlocking {
    var pl
    pl = MCPlayer.getUuid("Aliorpse") // "ec042e1200ac4a249cc83eb1fab0bd88"
    pl = MCPlayer.getProfile("Aliorpse")
    pl = MCPlayer.getProfile("ec042e1200ac4a249cc83eb1fab0bd88")
    pl = MCPlayer.getProfile("ec042e12-00ac-4a24-9cc8-3eb1fab0bd88")
}

Check out the project's dokka for the full API reference. There may be some extension functions you’ll find useful.

Java Usage

The project uses kotlin-suspend-transform-compiler-plugin to automatically generate variants.

CompletableFuture<ServerStatus> status =
        MinecraftServer.getStatusAsync("mc.hypixel.net");