diff --git a/.github/images/banner.png b/.github/images/banner.png index f3d0e4041..d58d7ffa8 100644 Binary files a/.github/images/banner.png and b/.github/images/banner.png differ diff --git a/README.md b/README.md index 02cc397ba..f4b894298 100644 --- a/README.md +++ b/README.md @@ -1,72 +1 @@ -![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 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/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. +![Mangrove](.github/images/banner.png) \ No newline at end of file