Installation

Nukkit Installation

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.

Prerequisites

1. Java 8 or above (some plugins may not work properly on newer versions) [Windows, Ubuntu, CentOS, OS X]
2. The server jar, which can be found on our Jenkins https://ci.opencollab.dev/job/NukkitX/job/Nukkit/job/master/lastSuccessfulBuild/ copied to a new directory dedicated to your server

Installation

Windows

1. Paste the following text into a new text document:
   
   Code:

   java -jar nukkit-1.0-SNAPSHOT.jar
   
   pause

2. Save the file as start.bat into the directory where your nukkit-1.0-SNAPSHOT.jar is located.
3. Double click the batch file to start the server.

Linux

1. Paste the following text into a new text document:
   
   Bash:

   #!/bin/sh
   
   java -jar nukkit-1.0-SNAPSHOT.jar

2. Save the file as start.sh into the directory where your nukkit-1.0-SNAPSHOT.jar is located.
3. Open terminal in the directory and execute the following command:
   
   Bash:

   chmod +x start.sh

4. Run the startup script:
   Bash:

   ./start.sh

Mac OS X

1. Paste the following text into a new text document:
   
   Bash:

   #!/bin/sh
   
   cd "$( dirname "$0" )"
   
   java -jar nukkit-1.0-SNAPSHOT.jar

2. Save the file as start.command into the directory where your nukkit-1.0-SNAPSHOT.jar is located.
3. Open terminal and type into it (don't hit enter yet):
   
   Bash:

   chmod a+x

4. Drag your startup script file into the terminal window. (Make sure you have a space between chmod a+x and your startup script in the command) Then hit enter.
5. Double click the startup script to start the server.

Multicraft

Depending on your Minecraft host's configuration, you will have two ways to enable the use of Nukkit through Multicraft.

• If there's already an option for Nukkit in the JAR file selection menu, you can simply select it and restart your server upon save. However, this may not be recommended if your host does not keep up to date with the latest Nukkit builds.
• If you have access to upload custom server JARs (FTP), download the Nukkit JAR and enter in the name of the file via the JAR file input box located on the index of the panel. Some hosts may require you to rename your JAR to a specific name (like custom.jar) and then select it from the dropdown menu.

Post-Installation

Required folders and config files are created when you run the server for the first time. You may want to edit the configs to personalize your server.

For more information, see:

• server.properties
• nukkit.yml (Section needs to be added)

Localhost server

If you are unable to connect your server which is hosted on the same computer as you try to play on, do this:

1. Close Minecraft if it's open
2. Open Windows PowerShell as administrator and execute the following command:
   Code:

   CheckNetIsolation LoopbackExempt -a -n="Microsoft.MinecraftUWP_8wekyb3d8bbwe"

3. Start Minecraft and attempt to connect to your server with IP 127.0.0.1

If you have issues with Nukkit, you can ask help on the Nukkit Forums or Discord.

Plugins

Check out our Resources section to find a wide variety of free plugins. If you cannot find what you are looking for, Pokkit offers limited compatibility with Spigot plugins.

You can add your plugins by dropping the downloaded jar file into your plugins folder in your server directory and restarting the server. If it does not work or if you see errors seek help on the Nukkit Forums or Discord.