README
¶
Dragonfly
Dragonfly is a heavily asynchronous server software for Minecraft Bedrock Edition written in Go. It was written with scalability and simplicity in mind and aims to make the process of setting up a server and modifying it easy. Unlike other Minecraft server software, Dragonfly is generally used as a library to extend.
Getting started
Running Dragonfly requires at least Go 1.18. After starting the server through one of the methods below, ctrl+c may be used to shut down the server. Also check out the wiki for more detailed info.
Installation as library
go mod init github.com/user/module
go get github.com/df-mc/dragonfly
Installation of the latest commit
git clone https://github.com/df-mc/dragonfly
cd dragonfly
go run main.go
Developer info
Dragonfly features a well-documented codebase with an easy-to-use API. Documentation may be found here and in the subpackages found by clicking Directories.
Publishing your project on GitHub? Consider adding the #df-mc topic to your repository to improve visibility of your project.
Contributing
Contributions are very welcome! Issues, pull requests and feature requests are highly appreciated. Opening a pull request? Consider joining our Discord server to discuss your changes! Also have a read through the CONTRIBUTING.md for more info.
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package server implements a high-level implementation of a Minecraft server.
|
Package server implements a high-level implementation of a Minecraft server. |
|
block
Package block exports implementations of the Block interface found in the server/world package.
|
Package block exports implementations of the Block interface found in the server/world package. |
|
block/cube
Package cube provides types and functions to handle positions and rotations of voxel-based objects in a 3D world.
|
Package cube provides types and functions to handle positions and rotations of voxel-based objects in a 3D world. |
|
block/model
Package model has world.BlockModel implementations for each world.Block implementation in the block package.
|
Package model has world.BlockModel implementations for each world.Block implementation in the block package. |
|
cmd
Package cmd implements a Minecraft specific command system, which may be used simply by 'plugging' it in and sending commands registered in an AvailableCommandsPacket.
|
Package cmd implements a Minecraft specific command system, which may be used simply by 'plugging' it in and sending commands registered in an AvailableCommandsPacket. |
|
event
Package event exposes a single exported `Context` type that may be used to influence the execution flow of events that occur on a server.
|
Package event exposes a single exported `Context` type that may be used to influence the execution flow of events that occur on a server. |