Help Getting started

Connect a Realm

A Realm can't reach the internet itself, so one of our bot accounts joins it as a hidden player and relays for it.

How it works on a Realm

Realms don't let behaviour packs talk to the internet, so BedrockRelay works differently there. One of our relay bots joins your Realm as a player. It hears the chat, joins, leaves and deaths, and says Discord's messages in the game.

A small Realm pack goes into your Realm's world alongside it. With the pack, the bot:

The bot uses one of your Realm's player slots. The dashboard counts it, and the Players list marks it Our bot. If you play on a different account from the one that owns the Realm, the owner account can be the bot instead: see Using your owner account as the bot. The bot can also leave while nobody's playing, so your Realm is hosted near your players: see Where your Realm is hosted.

Achievements are kept. Unlike a dedicated server, a Realm doesn't need Beta APIs, and the Realm pack doesn't turn on any experiment. Minecraft's Realm settings may say "Achievements disabled" once the Realm has an add-on from outside the Marketplace, ours included, but achievements still unlock. They're lost only if the world turns on an experiment itself, or goes into Creative.

Setting it up

Open the dashboard, choose Set up a new world, pick your Discord server, then choose Minecraft Realm.

Setup asking what you're connecting, with Minecraft Realm and Bedrock Dedicated Server side by side
Choose Minecraft Realm. The steps after this depend on your choice.
  1. Sign in as the Realm owner. Use the Microsoft account that owns the Realm. We use it to list your Realms, invite our bot and make it an operator, and add the pack to your world, now and for updates.
  2. Choose your Realm. You see every Realm you own. Choose Connect, and our bot is invited. A Realm you've already connected to another Discord server says Use this one instead: setup skips adding the pack and goes straight to choosing a channel.
  3. Add BedrockRelay to your Realm. Tick that you understand the Realm is closed until this is finished, then choose Add the pack. We close the Realm, download its world, add the pack, upload it and open the Realm again. Anyone playing is disconnected meanwhile, and other packs aren't touched. You can leave the page while it runs.
  4. Choose a channel. Chat starts flowing as soon as our bot is in.

Adding the pack yourself

Choose Download it and add it myself if you'd rather your Realm wasn't closed and re-uploaded, which suits big worlds. Worlds over 4 GB have to be done this way.

  1. Open the downloaded .mcpack file on a device with Minecraft. Minecraft imports the pack.
  2. In Minecraft, go to Play, then the Realms tab, and open your Realm's hub. Choose World, then Edit World, and under Behavior Packs activate BedrockRelay.
  3. Press Play, then Save Changes. Minecraft uploads the pack and reloads your Realm, and the setup step finishes by itself once the pack answers our bot.

The file carries your Realm's own secret, so keep it to yourself.

Updating the Realm pack

When a new Realm pack is out, the Realm's card and its Settings tab offer Update pack. It goes in the same way as the first time: the Realm is closed until it's finished, then opens again by itself. Your channels, settings and plugins stay as they are, and the progress shows at the top of the Realm's page.

Uploading or replacing the Realm's world from Minecraft, or changing its add-ons there, gives the Realm the packs on that device, so the BedrockRelay pack goes. The Realm's page then says the pack isn't in the world any more and offers Add the pack again. Do it after each such change.

The pack is in one world only. A Realm holds up to three worlds, in slots, and the pack goes into the one the Realm is playing when you add it. If you switch the Realm to a different world, the page says so and names both slots: switch back in your Realm's settings in Minecraft, or choose Add the pack to this world.

Keeping the pack up to date for you

On the Realm's Settings tab, turn on Keep the BedrockRelay pack up to date and BedrockRelay does both of these for you: it puts the pack back when it goes missing, and updates it when a new version is out. It's off until you turn it on.

  • It waits until nobody has been on your Realm for 10 minutes, because the Realm closes for about a minute while the pack goes in.
  • It does this at most once every 6 hours. If it doesn't work, it stops and waits for you to add the pack yourself.
  • It uses your kept Microsoft sign-in, so it pauses if you sign out of Microsoft.
  • Choose a channel under Post in a channel when it does and your players get a short note there each time.

What's different on a Realm

  • Chat from rank addons: our bot reads the line players see, such as [VIP] Steve: hi. See Joins show in Discord, but chat doesn't.
  • Plugins go in with the Realm pack, so installing one closes the Realm until it's finished. Only plugins marked Works on Realms can be installed.
  • No join address or pack tokens: our bot handles both, so the Realm's Settings tab doesn't show them.
  • Switching relaying off on the Realm's Overview tab makes our bot leave it until you switch it back on. See Switching relaying off.
  • Removing a Realm makes our bot leave it. Like a server, you can undo it for 7 days.

Your Microsoft sign-in

A Realm's pack lives inside its world, so every pack install or update needs the owner's permission. That's why BedrockRelay keeps your Microsoft sign-in, and why it's handled carefully:

  • It's kept encrypted, and used only with Minecraft Realms, only on Realms you own.
  • It's never used to join a Realm unless you choose it as a Realm's bot (see Using your owner account as the bot). Otherwise our bot joins with its own account. It's never used to sign in anywhere else as you.
  • Choose Sign out of Microsoft on your Account page and it's deleted at once. Your Realms keep relaying; adding or updating their pack asks you to sign in again.

Using your owner account as the bot

Our bot is a player in your Realm, so it takes one of its player slots. If you play on a different account from the one that owns the Realm, the owner account can be the bot instead, and every slot is free for players.

  • Switch on Use my Realm owner account as the bot on the Realm's Settings tab. It needs your Microsoft sign-in (from the account that owns the Realm) and the Realm pack v1.3.0 or later.
  • While it's the bot, the owner account is hidden in spectator mode in the End, shows as online in Minecraft all the time, and can't join the Realm itself: the Realm keeps whichever login came first.
  • Switch it off and our bot takes over again. The next time the owner account joins, its player goes back to where it was, in the game mode it had.
  • If you sign out of Microsoft, our bot takes over at once.
The Realm's Settings tab, with the Use my Realm owner account as the bot switch
Settings → Which account is the bot. The switch is greyed out until you're signed in to Microsoft with the Realm's owner account and the pack is v1.3.0 or later.

Where your Realm is hosted

Minecraft hosts each Realm session in the data centre closest to whoever joins first, unless you've chosen a region in the Realm's settings. A session ends a few minutes after the last player leaves. Our bot joins from Europe and normally stays in the Realm all the time, so the session never ends and the Realm stays wherever it started. If the bot was the first one in, that's Europe.

If your players live far from Europe, or far from each other, switch on Leave when nobody's playing on the Realm's Settings tab:

  • The bot leaves once it's had the Realm to itself for two minutes, so the session can end.
  • It never joins an empty Realm. It checks every 30 seconds whether anyone is playing, and joins once someone is, so the Realm is hosted near that player.
  • While nobody's playing, the dashboard shows Waiting for players. Nothing is relayed, and nothing is posted to your Status channels: an empty Realm isn't an offline one.
  • Chat from the first minute or so of a session, before the bot is back, isn't relayed. The players who started the session are still announced when the bot arrives.
  • While nobody's playing, your Realm isn't running at all, as with any Realm nobody's in. Plugins and add-ons that do things on a timer pause until someone plays. Live boards are refreshed one last time as the bot leaves, then keep that update, greyed and marked as nobody playing, until someone plays again.

Leave it off if you need your Realm running all the time, for example for a plugin that runs timed events.

The Settings tab also shows your Realm's own region setting. If it's anything other than Automatic, first to join, our bot doesn't change where the Realm is hosted, and you can leave this off. Choosing a specific region in the Realm's settings in Minecraft also keeps it out of Europe, even with the bot staying in.

The Realm's Settings tab, with the Leave when nobody's playing switch
Settings → When nobody's playing. Below the switch: your Realm's own region setting, as our bot reads it.

FarmBot: keeping a farm running

Our bot can stand at your farm in creative mode instead of hiding in the End, so mobs keep spawning there while nobody's playing. See FarmBot.

If something goes wrong

  • Your Realm didn't open again: in Minecraft, open the Realm's settings and turn off Temporarily close.
  • Our bot isn't in your Realm any more: if it was removed from the Realm's members, it stops trying to join after half an hour, and the Realm's page says so. Choose Set up again there and we invite it back with your Microsoft sign-in. For two weeks we also look again every few hours, in case you invited it back yourself.
  • Your Realm's subscription has ended: our bot can't join, so it stops trying. Once you renew it, choose Try again on the Realm's page.
  • Your Realm banned our bot: it stops trying to join, and the Realm's page says so. This is often an anti-cheat add-on. Unban the bot in Minecraft, then choose Try again on the Realm's page.
  • The pack isn't in the world any more, or hasn't answered our bot: choose Add the pack again at the top of the Realm's page. See Updating the Realm pack for why it goes missing.
  • Minecraft refused the sign-in: sign in to Minecraft with that account once to accept Minecraft's terms, and check its Xbox privacy settings allow multiplayer. A child account needs a parent to allow online play first.

Every failure in setup says what happened and what to do. If it happens again, tell us on the Discord support server.

Ready to connect a world, or need to change something?

Open the dashboard