Nukkit Introduction



# ❓ What is Nukkit ❓

Nukkit is a server type executing a ** `.jar` ** file to generate all necessary data to start a Bedrock server.

* Coming a few years after PocketMine-Mp, NukkitX (or commonly called Nukkit), provides much more constant updates compared to PocketMine-MP, and of course, gigantic plugins variety (also with constant updates).

* All of these features make this innovative software much heavier than other competitors like PocketMine-MP but’s always a good alternative.

* Also, there’s no way to use command blocks.

If you’re looking to create a public server, with many professional plugins, setup, and configurations, NukkitX is a good option.

—

**Possible Connections:**

* Minecraft Pocket Edition – MCPE – (Android and IOS)
* Minecraft Windows 10 Edition – Win10 – (From Microsoft Store)

—

**Useful NukkitX Links:**

* [NukkitX GitHub](https://github.com/NukkitX/Nukkit)
* [NukkitX Plugins](https://nukkitx.com/resources/categories/nukkit-plugins.1/)
* [NukkitX Website](https://nukkitx.com/)

—

# Change Your Server to Nukkit

To get Nukkit running on your server you will have to change your `Server Type` to the option with the same name and let a new world be generated.

||| ⚠ NOTE ⚠: We have a guide explaining how to change the `Server Type` [here](https://help.ggservers.com/en-us/article/how-to-change-your-server-type-and-version-ve6dtm/) if needed.

Also, we suggest you start the process with a backup of any important files!

||| ⚠ NOTE ⚠: [Here](https://help.ggservers.com/en-us/article/how-to-connect-to-your-server-using-filezilla-yl0q5r/) is our guide explaining how to use FileZilla to download any important files.

—

To change your `Server Type` to `Nukkit` you will have to follow the next steps:

1. Log in to your Multicraft panel [here](https://mc.ggservers.com/site/login) and stop your server.


—

2. Scroll down and click on the `Server Type` option, then select `Nukkit`.


—

3. Generate a new world.


If you want to keep your current world, we recommend clicking `Yes` here. This will create a completely new world and save your current world in case you want to go back to that version of Minecraft and play on it.


Click `Ok` when you see this popup.

—

4. Start Your Server

You can now open your Nukkit server by clicking the `Start` button.


—

5. After the installation you will have to set a language for the server to be able to start. For English type just `eng` in the console as you see below.


Now you just changed your server to Nukkit.

—

# ️ Server Settings ️

Check out the next box. This is an example of a Nukkit `server.properties` file.

“`motd=Nukkit Server For Minecraft: PE
server-port=19132
server-ip=0.0.0.0
view-distance=10
white-list=off
announce-player-achievements=on
spawn-protection=16
max-players=20
allow-flight=off
spawn-animals=on
spawn-mobs=on
gamemode=0
force-gamemode=off
hardcore=off
pvp=on
difficulty=1
generator-settings=
level-name=world
level-seed=
level-type=DEFAULT
enable-query=on
enable-rcon=off
rcon.password=
auto-save=on“`

### What does each option do?

* **motd**: Can be seen on Minecraft.
* **server-port**: Sets a server port.
* **server-ip**: Sets a server IP Address.
* **view-distance**: Sets a players view distance.
* **white-list**: Add a white list to server.
* **announce-player-achievements**: If player is logged on XBOX him can get announce about achievements.
* **spawn-protection**: Set the Spawn Protection size.
* **max-players**: Sets a max player count.
* **allow-flight**: Allows flight.
* **spawn-animals**: Allows to spawn animals.
* **spawn-mobs**: Allow to spawn mobs.
* **gamemode**: Sets the server game mode.
* **force-gamemode**: Forge a game mode on the server.
* **hardcore**: Enable hardcore.
* **pvp**
* **difficulty**: Sets the server difficulty.
* **generator-settings**
* **level-name**: Sets the actual level name.
* **level-seed**: Sets the actual level seed.
* **level-type**: Sets the actual level type.
* **enable-query**
* **enable-rcon**
* **rcon.password**: Sets the rcon password.
* **auto-save**

—

# How Do I Get Admin Privileges on My Server

To get admin privileges on your server and be able to use all commands you need to:

1. Log into your Multicraft Control Panel [here](https://mc.ggservers.com/site/login).

—

2. Make sure you’re on your server’s page. On the left-hand side of your Control Panel click ‘Console’.


—

3. In the text box above the console, type `op `, then either click on `Send` or press the `Enter` key.

|| ⚠ NOTE ⚠: You need to replace `` with your actual username.

**Example:**

“`
op ggservers
“`


||| Should you make changes to who has OP permissions on your server, please use the `/deop ` command. This command can be executed by any OP player in-game and it can also be executed via the console to remove the OP privileges from a player.

—

# ⌨ Nukkit Commands ⌨

1.
###### `/ban`

Prevents the specified player from using this server.

—

2.
###### `/ban-ip`

Prevents the specified IP address from using this server.

—

3.
###### `/banlist`

View all players banned from this server.

—

4.
###### `/debugpaste`

Uploads server information to Hastebin

—

5.
###### `/defaultgamemode`

Set the default game mode.

—

6.
###### `/deop`

Takes the specified player’s operator status.

—

7.
###### `/difficulty`

Sets the game difficulty.

—

8.
###### `/effect`

Adds/Removes effects on players

—

9.
###### `/enchant`

Adds enchantments on items.

—

10.
###### `/gamemode`

Changes the player to a specific game mode.

—

11.
###### `/gamerule`

Sets or queries a game rule value

—

12.
###### `/gc`

Fires garbage collection tasks.

—

13.
###### `/give`

Gives the specified player a certain amount of items.

—

14.
###### `/help`

Shows the help menu.

—

15.
###### `/kick`

Removes the specified player from the server.

—

16.
###### `/kill`

Commit suicide or kill other players.

—

17.
###### `/list`

Lists all online players.

—

18.
###### `/me`

Performs the specified action in chat.

—

19.
###### `/op`

Gives the specified player operator status.

—

20.
###### `/pardon`

Allows the specified player to use this server.

—

21.
###### `/pardon-ip`

Allows the specified IP address to use this server.

—

22.
###### `/particle`

Adds particles to a world.

—

23.
###### `/plugins`

Gets a list of plugins running on the server.

—

24.
###### `/reload`

Reloads the server configuration and plugins.

—

25.
###### `/save-all`

Saves the server to disk.

—

26.
###### `/save-off`

Disables server autosaving.

—

27.
###### `/save-on`

Enables server autosaving.

—

28.
###### `/say`

Broadcasts the given message as the sender.

—

29.
###### `/seed`

Shows the world seed.

—

# ✔️ Setting Up a Whitelist ✔️

The whitelist is as its name suggests a list of players that are allowed to join. Any other player that tries to join and is not on the list will be disconnected.

|| ⚠ NOTE ⚠: The actual whitelist is saved in your server files inside the `white-list.txt` file, but we do not recommend editing that file manually but using the following commands. Modifying that file can make the server crash at the first start!

To manage your whitelist on your Nukkit server you will use the following commands:

1.
###### `/whitelist `

Enable or disable the whitelist.

**Example**:

`/whitelist off`

Disable the whitelist.

—

2.
###### `/whitelist `

Add or remove a specific player from the whitelist.

**Example**:

`/whitelist add player1`

Will add player1 to our whitelist.

—

3.
###### `/whitelist list`

It will show all players from your whitelist.

—

4.
###### `/white-list reload`

Will reload your whitelist according to your `white-list.txt` file.

—

# How to Install Plugins

First, please note that NukkitX does not work with Bukkit/Spigot plugins, it specifically needs NukkitX plugins.

After downloading the plugins you want, just use Filezilla to upload them to your `plugins` folder of the server and restart it.


|| ⚠ NOTE ⚠: [Here](https://help.ggservers.com/en-us/article/how-to-connect-with-filezilla-yl0q5r/) is our guide for using Filezilla.

||| We please you to also take a look [here](https://help.ggservers.com/en-us/article/pocketmine-recommended-plugins-3sk5qh/) at our guide for recommended plugins for PocketMine. You will find there recommended plugins for anything from essentials commands to anti-cheat and minigames plugins.

—

# How to Get Mobs on Your Server

To get mobs working on Nukkit, you’ll need to set up the MobPlugin plugin which can be found [here](https://nukkitx.com/resources/mobplugin.3/).


Just download it and drop it into your server `plugins` folder using Filezilla, then restart the server.


|| ⚠ NOTE ⚠: [Here](https://help.ggservers.com/en-us/article/how-to-connect-with-filezilla-yl0q5r/) is our guide for using Filezilla.

—

# Setting Up Permissions

For managing permissions better on the Nukkit server we suggest you use a permission plugin, like LuckPerms, the Nukkit version. [Here](https://luckperms.net/download) you can find it.

||| [Here](https://help.ggservers.com/en-us/article/luckperms-installation-9eqlef/) is our guide for setting up and configuring LuckPerms, please take a look.

—

# ️ Setting Up Your Custom World ️

Please note that Nukkit has a unique world type. If you want to upload a world, you can only use a world that was previously generated with Nukkit.

|| ⚠ NOTE ⚠: You cannot upload your single-player world to your Nukkit because it was not generated with Nukkit but with the Vanilla version of the Bedrock game. Also, you cannot upload a world generated previously with the `Bedrock Dedicated` server type to a Nukkit server.

So if you have a world that was generated previously via Nukkit you can upload it to your server files as our guide explains [here](https://help.ggservers.com/en-us/article/how-to-upload-your-custom-world-on-a-bedrock-dedicated-server-bwwamw/).

—

| If you find any issues setting up and using Nukkit please feel free to contact us on live chat or via the ticket system [here](https://ggservers.com/billing/submitticket.php).

—

# ❕ Useful Links ❕

– [Why Is My Nukkit Server Not Launching?](https://help.ggservers.com/en-us/article/why-is-my-nukkit-server-not-launching-1xlyqp0/)
– [Nukkit Recommended Plugins](https://help.ggservers.com/en-us/article/nukkit-recommended-plugins-espxio/)
– [How to Upload Your Custom World on a Bedrock Server](https://help.ggservers.com/en-us/article/how-to-upload-your-custom-world-on-a-bedrock-dedicated-server-bwwamw/)