Skip to content

Aliorpse/mcutils

Repository files navigation

mcutils

Quality Gate Status Maven Central View on DeepWiki

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

Modules

Server Status

tech.aliorpse.mcutils:mcutils-server-status:$version

Warning

Native targets do not yet support an SRV record implementation. Setting enableSrv = true won't have any effect.

runBlocking {
    val status1 = MCServer.getStatus("mc.hypixel.net")
    val status2 = MCServer.getStatus(host = "wdsj.net", port = 25565, enableSrv = false)

    val queryFull = MCServer.getQueryFull("mc.hypixel.net")
    val queryBasic = MCServer.getQueryBasic("mc.hypixel.net")
}

Remote Console

tech.aliorpse.mcutils:mcutils-rcon:$version

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

Player Profile

tech.aliorpse.mcutils:mcutils-player:$version

Tip

This module requires a Ktor client engine, e.g., ktor-client-cio.

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.