Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shynixn/mccoroutine
MCCoroutine is a library, which adds extensive support for Kotlin Coroutines for Minecraft Server environments.
https://github.com/shynixn/mccoroutine
async await bukkit bungeecord coroutine extension functions hacktoberfest kotlin kotlin-coroutines library minecraft minestom-library plugin server spigot sponge suspend velocity waterfall
Last synced: about 1 month ago
JSON representation
MCCoroutine is a library, which adds extensive support for Kotlin Coroutines for Minecraft Server environments.
- Host: GitHub
- URL: https://github.com/shynixn/mccoroutine
- Owner: Shynixn
- License: other
- Created: 2018-11-09T10:19:30.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T15:58:00.000Z (about 1 month ago)
- Last Synced: 2024-10-11T03:40:24.925Z (about 1 month ago)
- Topics: async, await, bukkit, bungeecord, coroutine, extension, functions, hacktoberfest, kotlin, kotlin-coroutines, library, minecraft, minestom-library, plugin, server, spigot, sponge, suspend, velocity, waterfall
- Language: Kotlin
- Homepage:
- Size: 37.5 MB
- Stars: 206
- Watchers: 9
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MCCoroutine [](https://maven-badges.herokuapp.com/maven-central/com.github.shynixn.mccoroutine/mccoroutine-bukkit-api) [](https://raw.githubusercontent.com/Shynixn/MCCoroutine/master/LICENSE)
| branch | status | version | download |
| ------------- | ------------- | --------| ---------|
| master | [](https://github.com/Shynixn/MCCoroutine/actions)|  |[Download latest release](https://repo1.maven.org/maven2/com/github/shynixn/mccoroutine/)|
| development | [](https://github.com/Shynixn/MCCoroutine/actions) | | [Download snapshots](https://oss.sonatype.org/content/repositories/snapshots/com/github/shynixn/mccoroutine/) |
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:**
```kotlin
// Allows to prepend suspend to any listener function.
class PlayerConnectListener : Listener {
@EventHandler
suspend fun onPlayerJoinEvent(playerJoinEvent: PlayerJoinEvent) {
}
}
```
```kotlin
// Adds a new interface for suspendable command executors.
class AdminCommandExecutor: SuspendingCommandExecutor {
override suspend fun onCommand(sender: CommandSender,command: Command,label: String,args: Array): Boolean {
return false
}
}
```
```kotlin
// 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](https://shynixn.github.io/MCCoroutine/wiki/site/)
## Resources
* [MCCoroutine JavaDocs for the Bukkit-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.bukkit/index.html)
* [MCCoroutine JavaDocs for the BungeeCord-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.bungeecord/index.html)
* [MCCoroutine JavaDocs for the Fabric-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.fabric/index.html)
* [MCCoroutine JavaDocs for the Folia-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.folia/index.html)
* [MCCoroutine JavaDocs for the Minestom-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.minestom/index.html)
* [MCCoroutine JavaDocs for the Sponge-v7.x.x-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.sponge/index.html)
* [MCCoroutine JavaDocs for the Velocity-API](https://shynixn.github.io/MCCoroutine/apidocs/mccoroutine-root/com.github.shynixn.mccoroutine.velocity/index.html)
* [Article on custom frameworks](https://github.com/Shynixn/MCCoroutine/blob/master/ARTICLE.md)
## 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
The source code is licensed under the MIT license.