github.com/df-mc/dragonfly@v0.9.13/README.md (about)

     1  <!--suppress ALL -->
     2  <img height="310" alt="image" src="https://user-images.githubusercontent.com/16114089/121805566-0cd81280-cc4c-11eb-9b7d-b5f8a6db4f8d.png" align="right">
     3  
     4  # Dragonfly
     5  
     6  Dragonfly is a heavily asynchronous server software for Minecraft Bedrock Edition written in Go. It was written with scalability
     7  and simplicity in mind and aims to make the process of setting up a server and modifying it easy. Unlike other
     8  Minecraft server software, Dragonfly is generally used as a library to extend.
     9  
    10  [![Discord Banner 2](https://discordapp.com/api/guilds/623638955262345216/widget.png?style=banner2)](https://discord.gg/U4kFWHhTNR)
    11  
    12  ## Getting started
    13  Running Dragonfly requires at least **Go 1.21**. After starting the server through one of the methods below,
    14  **ctrl+c** may be used to shut down the server. Also check out the [wiki](https://github.com/df-mc/dragonfly/wiki) for
    15  more detailed info.
    16  
    17  #### Installation as library
    18  ```shell
    19  go mod init github.com/user/module
    20  go get github.com/df-mc/dragonfly
    21  ```
    22  
    23  ![SetupLibrary](https://user-images.githubusercontent.com/16114089/121804512-0f843900-cc47-11eb-9320-d195393b5a1f.gif)
    24  
    25  #### Installation of the latest commit
    26  ```shell
    27  git clone https://github.com/df-mc/dragonfly
    28  cd dragonfly
    29  go run main.go
    30  ```
    31  
    32  ![SetupClone](https://user-images.githubusercontent.com/16114089/121804495-ff6c5980-cc46-11eb-8e31-df4d94782e5b.gif)
    33  
    34  ## Developer info
    35  [![Go Reference](https://pkg.go.dev/badge/github.com/df-mc/dragonfly/server.svg)](https://pkg.go.dev/github.com/df-mc/dragonfly/server)
    36  
    37  Dragonfly features a well-documented codebase with an easy-to-use API. Documentation may be found
    38  [here](https://pkg.go.dev/github.com/df-mc/dragonfly/server) and in the subpackages found by clicking *Directories*.
    39  
    40  Publishing your project on GitHub? Consider adding the **[#df-mc](https://github.com/topic/df-mc)** topic to your
    41  repository and opening a pull request at [df-wiki](https://github.com/df-mc/wiki) adding your project as a Community
    42  Project to improve its visibility.
    43  
    44  ## Contributing
    45  Contributions are very welcome! Issues, pull requests and feature requests are highly appreciated. Opening a pull
    46  request? Consider joining our [Discord server](https://discord.gg/U4kFWHhTNR) to discuss your changes! Also have a read through the
    47  [CONTRIBUTING.md](https://github.com/df-mc/dragonfly/blob/master/.github/CONTRIBUTING.md) for more info.