Skip to content

README.md

Latest commit

 

History

History
62 lines (40 loc) · 2.15 KB

README.md

File metadata and controls

62 lines (40 loc) · 2.15 KB

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 server/build/libs directory.

Running

Simply run java -jar Cloudburst.jar.

Plugin API

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

Docker

Run from the repo root:

docker compose -f server/docker-compose.yml up -d

The default language is en_US. To change it, append --language <locale> to the command.

Server data is persisted in the cloudburst-data named volume. To access the interactive console after starting:

docker attach cloudburst

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.