Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rustytrim/server

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/rustytrim/server
Owner: rustytrim
License: gpl-3.0
Created: 2021-04-28T17:45:10.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-04-28T19:11:55.000Z (over 3 years ago)
Last Synced: 2024-06-03T22:21:38.844Z (7 months ago)
Language: Java
Size: 13.8 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

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

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](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 nuclear-powered 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.nukkitx.com/job/NukkitX/job/Server/job/master/)__

* __[Plugins](https://cloudburstmc.org/resources/categories/nukkit-plugins.1)__

* __[Wiki](https://cloudburstmc.org/wiki/nukkit)__

Build JAR file

-------------

- `git clone https://github.com/CloudburstMC/Server.git`

- `cd Server`

- `git submodule update --init`

- `./mvnw clean package`

The compiled JAR can be found in the `target/` 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/nukkit/).

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.