Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.31 KB

README.md

File metadata and controls

72 lines (51 loc) · 2.31 KB
Raw

Cloudburst

License: GPL v3 Build Status Tests Discord

Introduction

Cloudburst is a server software for Minecraft: Bedrock Edition. It has a few key advantages over other server software:

  • Written in Java, Cloudburst is faster and more stable.
  • Having a friendly structure, it's easy to contribute to Cloudburst's development and rewrite plugins from other platforms into Cloudburst plugins.

Cloudburst is under improvement, yet we welcome contributions.

Links

Build JAR file

  • git clone https://github.com/CloudburstMC/Cloudburst.git
  • cd Cloudburst
  • git submodule update --init
  • ./gradlew shadowJar

The compiled JAR can be found in the build/libs directory.

Running

Simply run java -jar Cloudburst.jar.

Plugin API

Information on Cloudburst's API can be found at the wiki.

Docker

Running Nukkit in Docker (17.05+ or higher).

Build image from source,

docker build -t nukkit .

Run once to generate the /data volume, default settings, and choose language,

docker run -it --rm -p 19132:19132 nukkit

Use docker-compose to start server on port 19132 and with ./data volume,

docker-compose up -d

Contributing

Please read the CONTRIBUTING guide before submitting any issue. Issues with insufficient information or in the wrong format will be closed and will not be reviewed.