diff --git a/README.md b/README.md index 620b263e8..9e646b381 100644 --- a/README.md +++ b/README.md @@ -1,118 +1,7 @@ -![nukkit](.github/images/banner.png) +# Nukkit PetteriM1 Edition -[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE) -[![Build Status](https://ci.nukkitx.com/job/NukkitX/job/Nukkit/job/master/badge/icon)](https://ci.nukkitx.com/job/NukkitX/job/Nukkit/job/master/) -[![Discord](https://img.shields.io/discord/393465748535640064.svg)](https://discord.gg/5PzMkyK) +This is a custom version of [Nukkit](https://github.com/CloudburstMC/Nukkit), Minecraft Bedrock Edition server software written in Java. -Introduction -------------- +See the [wiki](https://github.com/PetteriM1/NukkitPetteriM1Edition/wiki) for more details. -Nukkit is nuclear-powered server software for Minecraft Bedrock Edition. -It has a few key advantages over other server software: - -* Written in Java, Nukkit is faster and more stable. -* Having a friendly structure, it's easy to contribute to Nukkit's development and rewrite plugins from other platforms into Nukkit plugins. - -Nukkit is under improvement yet, we welcome contributions. - -Links --------------------- - -* __[Forums](https://cloudburstmc.org/forums/)__ -* __[Discord](https://discord.gg/5PzMkyK)__ -* __[Wiki](https://cloudburstmc.org/wiki/nukkit)__ -* __[Download Nukkit](https://ci.opencollab.dev/job/NukkitX/job/Nukkit/job/master/)__ -* __[Download Plugins](https://cloudburstmc.org/resources/categories/nukkit-plugins.1/)__ - -Compile Nukkit -------------- -- `git clone https://github.com/CloudburstMC/Nukkit` -- `cd Nukkit` -- `git submodule update --init` -- `./gradlew shadowJar` - -The compiled JAR can be found in the `target/` directory. - -Note: You don't need to compile Nukkit yourself if you don't intend to modify the code. You can find precompiled JARs on Jenkins. - -Running -------------- -Simply run `java -jar nukkit-1.0-SNAPSHOT.jar`. - -Plugin API -------------- -Information on Nukkit's API can be found at the [wiki](https://nukkitx.com/wiki/nukkit/). - -Docker -------------- - -Running Nukkit in [Docker](https://www.docker.com/) (17.05+ or higher). - -Build image from the source, - -``` -docker build -t nukkit . -``` - -Run once to generate the `nukkit-data` volume, default settings, and choose language, - -``` -docker run -it -p 19132:19132/udp -v nukkit-data:/data nukkit -``` -Docker Compose -------------- - -Use [docker-compose](https://docs.docker.com/compose/overview/) to start server on port `19132` and with `nukkit-data` volume, - -``` -docker-compose up -d -``` - -Kubernetes & Helm -------------- - -Validate the chart: - -`helm lint charts/nukkit` - -Dry run and print out rendered YAML: - -`helm install --dry-run --debug nukkit charts/nukkit` - -Install the chart: - -`helm install nukkit charts/nukkit` - -Or, with some different values: - -``` -helm install nukkit \ - --set image.tag="arm64" \ - --set service.type="LoadBalancer" \ - charts/nukkit -``` - -Or, the same but with a custom values from a file: - -``` -helm install nukkit \ - -f helm-values.local.yaml \ - charts/nukkit -``` - -Upgrade the chart: - -`helm upgrade nukkit charts/nukkit` - -Testing after deployment: - -`helm test nukkit` - -Completely remove the chart: - -`helm uninstall nukkit` - -Pterodactyl Panel -------------- - -[Download the official egg](https://raw.githubusercontent.com/parkervcp/eggs/master/game_eggs/minecraft/bedrock/nukkit/egg-nukkit.json) +>[Download](https://github.com/PetteriM1/NukkitPetteriM1Edition/releases/latest)