https://github.com/df-mc/dragonfly

Minecraft Bedrock Edition server software written in Go
https://github.com/df-mc/dragonfly

bedrock-edition df-mc go golang hacktoberfest mcpe mcpe-server minecraft minecraft-bedrock-edition minecraft-server

Last synced: 3 months ago
JSON representation

Minecraft Bedrock Edition server software written in Go

• Host: GitHub
• URL: https://github.com/df-mc/dragonfly
• Owner: df-mc
• License: mit
• Created: 2019-09-06T14:17:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T22:41:16.000Z (6 months ago)
• Last Synced: 2024-05-22T23:34:56.100Z (6 months ago)
• Topics: bedrock-edition, df-mc, go, golang, hacktoberfest, mcpe, mcpe-server, minecraft, minecraft-bedrock-edition, minecraft-server
• Language: Go
• Homepage: https://discord.gg/U4kFWHhTNR
• Size: 7.17 MB
• Stars: 626
• Watchers: 36
• Forks: 131
• Open Issues: 114
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-minecraft - DragonFly

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.

[![Discord Banner 2](https://discordapp.com/api/guilds/623638955262345216/widget.png?style=banner2)](https://discord.gg/U4kFWHhTNR)

## Getting started

Running Dragonfly requires at least **Go 1.21**. 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](https://github.com/df-mc/dragonfly/wiki) for

more detailed info.

#### Installation as library

```shell

go mod init github.com/user/module

go get github.com/df-mc/dragonfly

```

![SetupLibrary](https://user-images.githubusercontent.com/16114089/121804512-0f843900-cc47-11eb-9320-d195393b5a1f.gif)

#### Installation of the latest commit

```shell

git clone https://github.com/df-mc/dragonfly

cd dragonfly

go run main.go

```

![SetupClone](https://user-images.githubusercontent.com/16114089/121804495-ff6c5980-cc46-11eb-8e31-df4d94782e5b.gif)

## Developer info

[![Go Reference](https://pkg.go.dev/badge/github.com/df-mc/dragonfly/server.svg)](https://pkg.go.dev/github.com/df-mc/dragonfly/server)

Dragonfly features a well-documented codebase with an easy-to-use API. Documentation may be found

[here](https://pkg.go.dev/github.com/df-mc/dragonfly/server) and in the subpackages found by clicking *Directories*.

Publishing your project on GitHub? Consider adding the **[#df-mc](https://github.com/topic/df-mc)** topic to your

repository and opening a pull request at [df-wiki](https://github.com/df-mc/wiki) adding your project as a Community

Project to improve its visibility.

## Contributing

Contributions are very welcome! Issues, pull requests and feature requests are highly appreciated. Opening a pull

request? Consider joining our [Discord server](https://discord.gg/U4kFWHhTNR) to discuss your changes! Also have a read through the

[CONTRIBUTING.md](https://github.com/df-mc/dragonfly/blob/master/.github/CONTRIBUTING.md) for more info.