hvownij / nukkit Goto Github PK

Nukkit is nuclear-powered server software for Minecraft: Pocket 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.

• News
• Forums
• Discord
• Download
• Plugins
• Wiki

• git clone https://github.com/CloudburstMC/Nukkit
• cd Nukkit
• git submodule update --init
• chmod +x mvnw
• ./mvnw clean package

The compiled JAR can be found in the target/ directory.

Simply run java -jar nukkit-1.0-SNAPSHOT.jar.

Information on Nukkit's API can be found at the wiki.

Running Nukkit in Docker (17.05+ or higher).

Build image from the 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 to start server on port 19132 and with ./data volume,

docker-compose up -d

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

Please read the CONTRIBUTING guide before submitting any issue. Issues with insufficient information or in the wrong format will be closed and will not be reviewed.