MCCoroutine

branch	status	version	download
master			Download latest release
development			Download snapshots

MCCoroutine is a library, which adds extensive support for Kotlin Coroutines for Minecraft Server environments.

Plugins for game servers and proxy servers often need to perform asynchronous operations (e.g. accessing databases) to be scalable for a large amount of players. MCCoroutine brings the full power of Kotlin Coroutines to them by extending the existing APIs with suspendable commands, events and schedules.

Supported Game Servers:

CraftBukkit
Fabric
Folia
Minestom
Paper
Spigot
SpongeVanilla v7.x.x
SpongeForge v7.x.x

Supported Proxies:

BungeeCord
Waterfall
Velocity

Examples:

// Allows to prepend suspend to any listener function.
class PlayerConnectListener : Listener {
    @EventHandler
    suspend fun onPlayerJoinEvent(playerJoinEvent: PlayerJoinEvent) {
    }
}

// Adds a new interface for suspendable command executors.
class AdminCommandExecutor: SuspendingCommandExecutor {
    override suspend fun onCommand(sender: CommandSender,command: Command,label: String,args: Array<out String>): Boolean {
        return false
    }
}

// Adds a new extension function to switch into a suspendable plugin coroutine.
fun bar() {
    plugin.launch {
        delay(1000)
        bob()
    }
}

private suspend fun bob() {
}

Getting started

Wiki and User Guide

Resources

Features

Full implementation of Kotlin Coroutines (async/await)
Extension functions for already established functions
Connection to events, commands, schedulers
Coroutine LifeCycle scope for plugins (supports plugin reloading)
No NMS
Support for Minecraft 1.7 - Latest
Support for Java 8+

Contributing

Fork the MCCoroutine project on GitHub and clone it to your local environment
Install Java 8+
Execute gradle sync for dependencies

Licence