Before you start

Make sure you have all of these. Most setup problems come from a missing item on this list.

• A Bedrock Dedicated Server (BDS). Nexus doesn't work in single-player, on Realms or in LAN worlds, because it needs the @minecraft/server-net module, which only exists on BDS.
• A BDS version that matches the pack. Nexus uses Minecraft's Beta Script APIs, which change with every Minecraft update. Always use the latest Nexus release for your Minecraft version. Check the downloads channel in our Discord after each Minecraft update.
• Access to the server's files (FTP, file manager or the machine itself), so you can edit two small config files.
• Access to the server console, so you can make yourself an operator.
• A Discord account, to claim your license key.

1Get a license key

Join our Discord and run this in any channel the bot can see:

/token free name:Your Server Name

You get a free key for 20 players with every feature, valid for 30 days. The name becomes your server's label and the name you sign in to the web console with, so use your real server name. For more slots, open a ticket to buy a plan.

• Forgot your key? Run /mytokens to see every key tied to your Discord account.
• Keep your key private. Anyone with it can connect a server as you. One key works on one server at a time.

2Enable Beta APIs

Nexus needs the Beta APIs experiment turned on in your world. Experiments are saved inside the world itself, so they can't be turned on from server.properties.

• New world: create it in Minecraft with Experiments → Beta APIs turned on, then upload the world folder to your server's worlds/ folder.
• Existing world: download it, open it once in Minecraft, turn on Beta APIs under Experiments in the world settings, save, and upload it back. Many hosting panels also have an experiments toggle.

3Allow the networking module

By default BDS blocks scripts from making network connections. Open config/default/permissions.json in your server folder (create the file if it doesn't exist) and make sure it contains:

{
  "allowed_modules": [
    "@minecraft/server",
    "@minecraft/server-ui",
    "@minecraft/server-net"
  ]
}

4Install the pack

• Download the pack with the button above. If it's a .mcpack or .mcaddon, rename it to .zip and extract it.
• Put the extracted folder in your server's behavior_packs/ folder, for example behavior_packs/Nexus/. The pack's manifest.json must be directly inside that folder, not one level deeper.
• Open worlds/<your world>/world_behavior_packs.json (create it if it doesn't exist) and add Nexus:

[
  { "pack_id": "d3a5b476-7e93-45c4-a3a8-88ae66bd2a2e", "version": [2, 0, 2] }
]

If the file already lists other packs, add the Nexus line inside the same brackets, separated by a comma. When you update Nexus later, update the version numbers to match the new pack's manifest.json.

Restart the server. You should see Nexus messages in chat and in the server console.

5Become a Nexus admin

Nexus setup commands only work for Nexus admins. To become one you must first be a server operator:

1. In the server console, run op YourGamertag.
2. Join the server and type in chat: !op. You'll see "You are now a nexus admin."
3. Recommended: protect admin access with a password (at least 8 characters). Other operators will then need it to become Nexus admins:

   !password set YourPassword YourPassword

To make another player a Nexus admin, run !op TheirName, adding the password at the end if you set one.

6Connect to Nexus

Type these two commands in chat:

!setToken your-license-key
!setServer EU

For setServer, choose the region closest to your server: NA (North America), EU (Europe) or AS (Asia).

Nexus connects by itself within about 10 seconds. You'll see these messages in chat:

That's it. Your server is protected. Run !info at any time to check the status.

7Set up the web console

1. Open the console and click Add console.
2. Enter your server name exactly as it appears in /mytokens (the name you chose in step 1).
3. The first time, you'll be asked for your license key and a new console password. Next time, just the server name and password.
4. Optional: click Sync with Discord to keep your consoles on every device you use.

Want staff to help? Go to Settings → Sub-users, create an invite link, and choose exactly what they can do.

8Set up the Discord bot

Add the Nexus bot to your Discord server using the invite link in our Discord, then run these commands as someone with Manage Server:

/setup link token:your-license-key
/setup channel type:Chat bridge channel:#minecraft-chat
/setup channel type:Flag log channel:#anticheat-logs
/setup channel type:Join log channel:#joins
/setup channel type:Leave log channel:#leaves
/setup status channel:#server-status ping:@Players

• Only /setup link is required. Add whichever channels you want. Discord shows the options as you type, so pick type from the list.
• Let staff moderate without admin rights: /access allow role:@Moderators command:mod (or a single action like mod:ban).
• See the Bot commands page for everything else.

In-game commands

Commands start with ! (or nexus.) and aren't case-sensitive. Everything except !help and !info needs a Nexus admin. You can change the ! prefix in the config.

Troubleshooting

Good to know

• If our backend goes down, the pack switches to its built-in local checks and reconnects by itself once it's back.
• Nexus admins aren't checked by the anticheat, so staff testing things aren't flagged. Only make people you trust Nexus admins.
• Actions on offline players made from the console or bot (ban, inventory edits and so on) run the moment they rejoin.
• Shulker box contents can't be read or edited, because Minecraft's scripting API doesn't expose them. Bundles work fine.
• After each Minecraft update, wait for the matching Nexus release before updating your server. Beta APIs usually change.

Stuck? Open a ticket in our Discord with a screenshot of the chat or server console message.

Questions about a command? Ask in our Discord.