Help Managing your world

Plugins

Add Discord commands for your world, like /lastdeath, /world and /top. Every plugin in the catalog has been reviewed.

Installing plugins

Everything about a world's plugins is on its own Plugins tab: open the world in the dashboard's sidebar, then the tab. Installed comes first, then Available plugins from the catalog, then Your own plugins. Search the available ones, pick a category, or sort them. Open a card with the arrow (or anywhere on it) for its commands and screenshots. A Realm is offered only the plugins that work on Realms.

The Location plugin's card under Available plugins on a world's Plugins tab; it has been added to the list
Choose Install on a card to add it to your list.
  1. Choose Install on each plugin you want. They collect in Your list, pinned to the bottom of the tab.
  2. Choose Apply in the list. Everything installs in one go, over one SFTP connection, with a preview first. On a Realm, plugins go in with the Realm pack, so the Realm is closed until that's finished.
  3. On a dedicated server, restart it so it loads the plugins; a Realm opens again by itself. Each one is switched on the first time the world reports it, so its commands appear in Discord straight away.
The list at the bottom of a world's Plugins tab, showing one planned change and the Apply button
Your list collects every install, update and removal, ready to apply in one go.

Installing by hand

On a dedicated server, every plugin card, opened, has Download it and install it yourself. Open it for the plugin's file and the steps: put the file in the folder it names on your server, add the plugin to the list in index.js, and restart. It's switched on for you, just like an install from the dashboard.

Plugins need pack v0.3.0 or newer, and some need a newer one. The Plugins tab says when a pack update is needed. Updating the pack never removes your plugins.

Every plugin, one by one

Each plugin in the catalog has a page of its own: what it does, how to use its commands, and what it needs. A plugin's card on the Plugins tab links to it under How to use it.

  • Statistics: everything players do, with top tens in Discord and a menu in game.
  • Player list: who's online, on what device, and for how long.
  • World: day, time, weather and server speed.
  • Scoreboards: top tens from any scoreboard other addons keep.
  • Player card: a player's health, hunger, level and effects.
  • Last death: where a player died and what they dropped.
  • Location: where a player is.
  • Inventory: what a player carries and keeps in their ender chest.
  • Map: the land around a player, drawn like an in-game map.
  • Skin: any player's skin, rendered in 3D.
  • Audit: posts when someone places TNT, pours lava or kills a villager.
  • Entity scan: find what's causing lag.
  • Map markers: markers on your BedrockMap map from in game.

Switching a plugin on and off

Installed plugins appear under Installed on the world's Plugins tab once the world has loaded them, already switched on, and their commands are added to the Discord servers the world is connected to. Switch one off to take its commands away; it stays off until you switch it back on. Click a plugin's name to open its card.

A plugin's card on a world's Plugins tab: its on switch, who can use it, the channels it posts to, and the kinds of post it makes
A plugin's card: switch it on (1), see who can use it (2) and choose where it posts (3).
  • Who can use it: at first only Discord administrators. Add roles on the world's Permissions tab, with every other command's: see Who can use what.
  • Who sees the answer: most answers are shown only to the person who asked, because they can reveal where people are or what they're carrying. A few, like /world and /top, are made to share and are shown to everyone in the channel.
  • Commands that change something in your world ask "are you sure?" first.

Plugins that post by themselves

Some plugins post without being asked. Statistics, for example, announces when someone reaches 100 hours played. Choose where its posts go under Posts to. It posts nowhere until you do.

Any channel connected to that world can be chosen, including one with no events ticked, just for plugin posts.

Some plugins post several kinds of thing. Audit, for example, can post when someone places TNT, spawns a wither or mines diamonds. They list each kind under What it posts: untick any you don't want, and the rest still go to the channels you chose.

Live boards

Some commands can be kept in a channel as a live board that updates itself, such as /top for a playtime leaderboard.

  • From Discord: run the command with live: True. The answer stays in that channel and updates itself, as often as the plugin suggests (every minute for /world, every 10 for /top).
  • From the dashboard: on the world's Plugins tab, open the plugin and choose Post to a channel. Pick what to show, the channel, and how often it updates, from every minute to once a day, or Don't update to post it once.
The Live boards list on a world's Plugins tab, with each board's channel, how often it updates and when it last did
Each board is listed in its plugin's card on the Plugins tab, where you can change how often it updates or remove it.

While its world is offline for more than a couple of minutes, or a Realm has nobody playing, a board turns grey and says so above its last update, and any countdown on it stops. It carries on by itself when the world is back.

Delete the board's message in Discord to stop it, or remove it on the dashboard. A world can have up to 10 live boards. If one can't update, the list says why, such as the world being offline or the bot missing a permission in that channel.

Menus in game

Some plugins give players a menu in Minecraft as well. Players type /relay to see every one, with or without cheats. A plugin can have a command of its own too, like /statistics, which opens its menu straight away. That needs the latest pack; on an older one, /relay still opens it.

Updating and removing

When a newer version is out, the plugin's card under Installed says so, and the tab shows how many updates are waiting. Open the card for Update, or add all of them at once from the notice above the list. Remove, in the same place, takes a plugin out of your world. Updates and removals go in the same list and are applied the same way. Your switches, roles and channels stay as they are.

Some plugins replace an older one. Statistics replaces Leaderboards: adding it takes Leaderboards out in the same step, and the players' totals carry over.

Plugins on Realms

Plugins marked Works on Realms can go on a Realm. They're installed inside the Realm pack, so installing, updating or removing one closes the Realm until it's finished, then it opens again by itself. Applying takes you to the Realm's overview, where the progress shows at the top. Plugins on a Realm need Realm pack v1.2.0.

What you're installing

Every plugin's code is public in the BedrockRelay plugins repository on GitHub, and each card's Source link opens it. Plugins only reach your world as the reviewed file, and only when you apply them.

Your own plugins

Want to write one? See the developer guide, then submit it to the repository for everyone.

Or keep it to yourself: under Your own plugins on any world's Plugins tab, choose Upload a plugin. It's listed only on your dashboard, on every one of your worlds, and installs like any other. Upload a file with the same id and a higher version to offer your worlds an update. To share one with everyone, open its card and choose Submit to the catalog: we review it first, and its card says whether it's waiting, published or declined, and why. Once it's published you maintain it: its catalog card shows you Submit an update for each new version.

Nobody reviews your own plugins, and they run in your Minecraft world, so only upload code you wrote or trust. The BedrockRelay team can see what's uploaded and where it's used, and can block a plugin that's harmful or abusive: it's then switched off on all your worlds, marked Blocked with the reason, and can't be installed or updated. Remove it from your worlds, then delete it. See private plugins.

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

Open the dashboard