Introduction
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.
Links
Thank you for visiting our official sites. Our official websites are provided free of charge, and we do not like to place ads on the home page affecting your reading. If you like this project, please donate to us. All the donations will only be used for Nukkit websites and services.
Build JAR file
git clone https://github.com/NukkitX/Nukkit
cd Nukkit
git submodule update --init
./mvnw clean package
The compiled JAR can be found in the target/
directory.
Running
Simply run java -jar nukkit-1.0-SNAPSHOT.jar
.
Plugin API
Information on Nukkit's API can be found at the wiki.
Docker
Running Nukkit in Docker (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 to start server on port 19132
and with ./data
volume,
docker-compose up -d
Contributing
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.