https://github.com/dockyardmc/dockyard
Custom implementation of the Minecraft server protocol in Kotlin
https://github.com/dockyardmc/dockyard
hacktoberfest kotlin minecraft minecraft-protocol minecraft-server-software netty nio
Last synced: 6 months ago
JSON representation
Custom implementation of the Minecraft server protocol in Kotlin
- Host: GitHub
- URL: https://github.com/dockyardmc/dockyard
- Owner: DockyardMC
- License: mit
- Created: 2023-06-07T17:27:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-06T11:27:28.000Z (6 months ago)
- Last Synced: 2025-04-06T12:27:17.417Z (6 months ago)
- Topics: hacktoberfest, kotlin, minecraft, minecraft-protocol, minecraft-server-software, netty, nio
- Language: Kotlin
- Homepage: https://dockyard.lukynka.cloud/
- Size: 6.84 MB
- Stars: 76
- Watchers: 3
- Forks: 9
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
[
](https://github.com/DockyardMC/Dockyard)
---
[](https://mvn.devos.one/#/releases/io/github/dockyardmc/dockyard)
[](https://kotlinlang.org/)
[](https://wakatime.com/badge/github/DockyardMC/Dockyard)
[](https://discord.gg/SA9nmfMkdc)
[](https://ko-fi.com/LukynkaCZE)
DockyardMC is an open-source, fast and lightweight Minecraft server protocol implementation that's written from scratch in Kotlin without any code from Mojang. It is focused on making developing and prototyping easy, simple and intuitive while having full control over every aspect of the server.
**This project currently under development, missing parts some users might rely on**
## Quick Start
You can read how to setup and use dockyard [here](https://dockyard.lukynka.cloud/wiki/quick-start)
## Features
- Modern, simple to use API which makes developing and prototyping easy and fast
- Lightweight and without all the overhead the vanilla server has
- Ability to take full control over every aspect of the server
- Fully multithreaded worlds
## API Examples
### Events
```kotlin
Events.on { event ->
if(banList.contains(event.player.uuid)) {
event.player.kick("You are banned!")
event.cancel()
return@on
}
broadcastMessage("→ ${event.player} has joined the server.")
}
```
Modifying events (including PacketReceived and PacketSent)
```kotlin
Events.on { event ->
if(event.packet is ServerboundPlayerChatMessagePacket) {
event.packet.message = "ha get overwritten >:3"
}
}
```
---
### Commands API
You can create commands quickly and easily with the DockyardMC command API
```kotlin
Commands.add("/explode") {
addArgument("player", PlayerArgument())
withPermission("player.admin")
withDescription("explodes a player")
execute { context ->
val executingPlayer = context.getPlayerOrThrow()
val player = getArgument("player")
player.spawnParticle(player.location, Particles.EXPLOSION_EMITTER, Vector3f(1f), amount = 5)
player.playSound(Sounds.ENTITY_GENERIC_EXPLODE, volume = 2f, pitch = randomFloat(0.6f, 1.3f))
player.sendMessage("You got totally exploded by $executingPlayer")
executingPlayer.sendMessage("You totally exploded player $player")
}
}
```
---
### Built-in Bossbar and Sidebar APIs
#### Sidebar API
```kotlin
val sidebar = Sidebar {
setTitle("My Cool Server")
setGlobalLine("")
setPlayerLine { player -> "Welcome, $player" }
setPlayerLine { player -> "World: ${player.world.name}" }
setPlayerLine { player -> "Ping: ${player.ping}" }
setGlobalLine("")
setGlobalLine("www.mycoolserver.uwu")
}
Events.on { event ->
sidebar.viewers.add(event.player)
}
```
Changing any lines, title etc. will automatically send update to the viewers
#### Bossbar API
```kotlin
val bossbar = Bossbar("The server has uptime is: $serverUptime!", 1f, BossbarColor.YELLOW, BossbarNotches.SIX)
Events.on { event ->
bossbar.addViewer(event.player)
}
```
Again, changing any properties of the bossbar will automatically send updates to the viewers
### Entity Metadata Layers
Layering entity metadata per player allows for client-side changes to entities for purposes like client-side glowing and client-side invisibility.
Note that this behaviour is not just sending one packet, but its whole system that overlays the player specific metadata layer over the entity's actual metadata
Here are few examples:
```kotlin
// pre-made functions to set client-side glowing and invisibility
entity.setGlowingFor(player, true)
entity.setInvisibleFor(player, false)
```
```kotlin
// get the metadata layer of player or create new one if it doesn't exist
val playerMetadataLayer = warden.metadataLayers[player] ?: mutableMapOf()
// create new EntityMetadata with index and type pose
val pose = EntityMetadata(EntityMetadataType.POSE, EntityMetaValue.POSE, EntityPose.ROARING)
// add the pose to the list
playerMetadataLayer[EntityMetadataType.POSE] = pose
warden.metadataLayers[player] = playerMetadataLayer
// specified player will now see the warden roaring
```
## Running
Dockyard is mainly designed as library that can be imported via maven. If you want to run dockyard you will need to embed it into your own kotlin app.
## Contributing
Contributions are always welcome! Please always check branches to see if the feature you are contributing is not already existing feature that someone else is working on
(plus you get cool fancy orange contributor role on the discord!!!)
## Related Libraries / Projects
- **[Scroll](https://github.com/DockyardMC/Scroll/)** - Minecraft component library made for DockyardMC
- **[Chart](https://github.com/DockyardMC/Chart)** - Minecraft NBT library made for DockyardMC
- **[kotlin-bindables](https://github.com/LukynkaCZE/kotlin-bindables)** - Bindable system inspired by [osu!framework](https://github.com/ppy/osu-framework/)
- **[Pathetic](https://github.com/Metaphoriker/pathetic)** - A powerful, optimized and easy-to-use Java A* Pathfinding Library for 3D environments.
- **[Spark](https://github.com/lucko/spark)** - A performance profiler for Minecraft clients, servers, and proxies
- **[PrettyLog](https://github.com/LukynkaCZE/PrettyLog/)** - Fancy logging library
## Authors
- [LukynkaCZE](https://www.github.com/LukynkaCZE)
- [AsoDesu](https://www.github.com/AsoDesu)
## Additional thanks to
- [KevDev](https://github.com/TrasherMC)
- [BluSpring](https://github.com/BluSpring)
- [Asoji](https://github.com/asoji)
- All the contributors
- Twitch chat who watches me code this! <3
---
If you want to support me and this project, consider [**buying me a coffee**](https://ko-fi.com/lukynkacze) <3