An open API service indexing awesome lists of open source software.

https://github.com/CloudburstMC/Cloudburst

Cloudburst Server is a Bedrock first server software. Originally forked from Cloudburst Nukkit.
https://github.com/CloudburstMC/Cloudburst

bedrock cloudburst cloudburst-server java mcbe mcbe-server mcpe mcpe-server minecraft minecraft-bedrock minecraft-server nukkit

Last synced: 4 months ago
JSON representation

Cloudburst Server is a Bedrock first server software. Originally forked from Cloudburst Nukkit.

Awesome Lists containing this project

README

          

![Cloudburst](.github/images/banner.png)

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](server/LICENSE)
[![Build Status](https://ci.nukkitx.com/job/NukkitX/job/Server/job/master/badge/icon)](https://ci.nukkitx.com/job/NukkitX/job/Server/job/master/)
![Tests](https://img.shields.io/jenkins/t/https/ci.nukkitx.com/job/NukkitX/job/Server/job/master.svg)
[![Discord](https://img.shields.io/discord/393465748535640064.svg)](https://discord.gg/5PzMkyK)

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
--------------------

* __[News](https://cloudburstmc.org)__
* __[Forums](https://cloudburstmc.org/forums)__
* __[Discord](https://discord.gg/5PzMkyK)__
* __[Download](https://ci.opencollab.dev/job/NukkitX/job/Server/job/bleeding/)__
* __[Plugins](https://cloudburstmc.org/resources/categories/cloudburst-plugins.19/)__
* __[Wiki](https://cloudburstmc.org/wiki/cloudburst)__

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](https://cloudburstmc.org/wiki/cloudburst/).

Docker
-------------

Running Nukkit in [Docker](https://www.docker.com/) (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](https://docs.docker.com/compose/overview/) to start server on port `19132` and with `./data` volume,

```
docker-compose up -d
```

Contributing
------------
Please read the [CONTRIBUTING](.github/CONTRIBUTING.md) guide before submitting any issue. Issues with insufficient information or in the wrong format will be closed and will not be reviewed.