forked from CloudburstMC/Cloudburst
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
1 addition
and
72 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1 @@ | ||
|  | ||
|
|
||
| [](server/LICENSE) | ||
| [](https://ci.nukkitx.com/job/NukkitX/job/Server/job/master/) | ||
|  | ||
| [](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. | ||
|  |