Command Block App

Manage and monitor your Minecraft servers from one dashboard inside Root.

note

You can install and manage Root's own Apps on desktop or mobile. Apps from other developers, and Bots, are installed from Root on desktop. Once installed into a community, Apps and Bots can be used on Root desktop and mobile.

What is Command Block?

Command Block is a community app that connects your Minecraft servers to Root so you can see who is playing, run console commands, chat with players in game, explore a live map, manage your whitelist and plugins, and track server performance. Community owners grant access to specific features through permission groups, so server managers, moderators, and members each see only what they need.

What works with Command Block

	Supported
Edition	Java Edition
Server software	Paper, Purpur, Fabric, NeoForge
Minecraft	1.21.1, 26.1, 26.2, 26.3

Bedrock, Realms, Forge and Aternos are not supported yet.

How it works

Each server runs a plugin called Root Companion. Root connects to it through the same address players use to join, and everything it sends is encrypted end to end. There are no extra ports to open or keys to copy.

Dashboard

The dashboard (Your Servers) shows every server as a card with its name, status, player count, server software and version, and address. Server managers can select Add Server at the top. Everyone can open Notifications and link their Minecraft account from there too.

Status	Meaning
Online	The server is running and connected to Root.
Setting up	Setup is not finished. The card says what the next step is.
Code expired	The pairing code ran out before it was used. Get a new code from the card.
Restarting	The server is restarting.
Reconnecting	Root lost the connection a moment ago and is reconnecting.
Offline	The server has been unreachable for a while. Root reconnects on its own when it comes back.
Connection failed	Root cannot reach the server. The card explains why in one sentence.
Re-pair required	The server needs to be paired with Root again. See Re-pair a server.

When a server needs attention, its card tells server managers what to do and offers the button for it, such as Edit address, Re-pair or Update Root Companion. Copy help link copies a link to this page. Other members see A server manager is setting this up. while setup is unfinished, or Ask a server manager to check the connection. when it can't connect.

Server tabs

Select a server card to open it. The tabs you see depend on your permissions:

Tab	What it shows	Who sees it
Server Info	Address, player count, edition, software and version, the message of the day, and the plugins or mods the server runs	Everyone
Players	Online and offline players with health, hunger, ping, session time and location	Everyone
Map	Live world map with player markers, powered by Squaremap	Map Access
Chat	In-game chat, plus a field to send messages	Chat Access
Analytics	Players now, peak and active players, average session, server health, and charts for the last 30 days	Analytics Access
Console	Live console output and a command field	Console Access
Connection	Join address, custom domain, connection type, pairing date and Root Companion version	Connection Access
Whitelist	Turn the whitelist on or off, approve requests, add or remove players	Server Managers
Plugins or Mods	Browse, install, update and remove plugins or mods	Server Managers

The last tab is called Mods on Fabric and NeoForge servers, and Plugins on the others.

Roles and permissions

Command Block uses seven permission groups, set by community owners:

Role	Description
Server Managers	Add, edit, and delete servers, update plugins, and run setup. They also get the Whitelist and Plugins or Mods tabs.
Console Access	View the server console and send commands.
Chat Access	View in-game chat and send messages.
Map Access	View the server map.
Analytics Access	View server analytics and refresh data.
Inventory Managers	View and edit player inventories.
Connection Access	View server connection details (address, connection type and pairing date).

Add a server

Server managers add servers from the dashboard.

1. Select Add Server.
2. Under Where does your server run?, choose one:
   • A hosting company: Root installs the plugin for you.
   • I run it myself: for a server on your own PC, a VPS or Docker. You install the plugin yourself.
   • I don't have a server yet: shows hosts that work with Root.

Not sure which to pick? Open Not sure? Paste something from your host, paste your SFTP address or panel link, and select Continue.

At a hosting company

1. Enter your server's SFTP login: SFTP address, Port, Username and Password. Root uses it once to install the plugin and does not store it.
2. Select Install the plugin →. Root checks your server software and version.
3. If Root asks Where do players join?, enter the address players type in Minecraft's Multiplayer screen.
4. Wait while Root installs Root Companion and links it to Root.
5. Restart your server from your host's panel. Root cannot do this step for you.
6. After the restart, Root connects on its own and shows You're connected.

If your host has no SFTP, open Where do I find this? and select Install the plugin yourself, then follow the steps below.

If you run it yourself, or install the plugin yourself

1. Under Where do players join?, enter the address players use to join, then select Continue.
2. Choose your server software (Paper / Purpur, Fabric or NeoForge). For Fabric and NeoForge, also choose your Minecraft version.
3. Select Copy link, open it in your browser, and download the plugin.
4. Put it in your server's plugins/ folder (mods/ on Fabric and NeoForge), then restart the server.
5. Copy the /rc pair command shown and run it in the server console. You can also type it in game as an op.
6. Root shows Waiting for your server to pair... and connects as soon as the command runs.

Pairing codes last ten minutes. If yours runs out, select New code.

tip

Rather not type a command? Open Rather not type a command? and select Download config.yml. Put the file in plugins/RootCompanion/ (config/rootcompanion/ on Fabric and NeoForge) and restart the server.

If you can't see what went wrong, open Need help? to see what each [RootCompanion] line in your server console means.

If you don't have a server yet

Choose I don't have a server yet to see hosts that work with Root. Select Copy link and open it in your browser to buy a server. Come back and select Add Server once your server is up. Root does not sell servers or take a cut.

Servers that were already connected

Servers set up before the new setup move to the new connection by themselves. Root Companion updates at your server's next normal restart, so nobody is kicked, and the console shows Switched to the new Root connection. You don't need to do anything.

Re-pair a server

Server managers can re-pair a server. If a card shows Re-pair required, or you need to pair a server again:

1. Select Re-pair on the server's card, or on its Connection tab while the server isn't connected.
2. Copy the /rc pair command and run it in the server console, or in game as an op. No restart is needed.

Change a server's address

Server managers can change the address Root uses to reach a server.

1. Select Edit address on the server's card, or Edit next to Players join at on the Connection tab.
2. Enter the new address and select Save. Root tries the new address straight away.

Servers behind a proxy like TCPShield

Proxies like TCPShield only pass Minecraft traffic, so Root needs a port of its own. Server managers can select Players connect through a proxy like TCPShield? on the card, or Set up next to Separate port on the Connection tab, and follow the steps: add a port in your host's panel, enter the address your panel shows for it, then run the /rc port command shown in the console.

Edit the server's name, message and icon

Server managers can change how the server looks in Root and in the Minecraft server list. The server must be online and running the latest Root Companion.

1. Open the server and select Edit at the top.
2. Change the Name, the two lines of the Message of the day, or the icon (Upload icon or Change icon). The preview shows how it will look.
3. Select Save.

A new icon usually shows straight away. If the server can't switch it while running, Root says Saved. The new icon shows after the next restart.

Whitelists

When a server's whitelist is on, members who are not on it see Whitelist only on the server's card and page.

Ask to join a whitelisted server

1. Select Apply on the server card, or Apply to join on the server page.
2. Enter your Minecraft name (Java Edition). If you have linked your Minecraft account, it is filled in for you.
3. Select Send request.

A server manager approves it, and you get a notification when you can join.

Manage the whitelist

Server managers get a notification for each request.

1. Open the server and select the Whitelist tab.
2. Under Requests, select Approve or Decline.
3. Use the switch to turn the whitelist on or off.
4. Under Players, enter a Minecraft name and select Add, or remove a player from the list.

The server must be online to approve requests, add or remove players, or turn the whitelist on or off.

Plugins and mods

Server managers can add plugins (Paper and Purpur) or mods (Fabric and NeoForge) from Modrinth. This works for servers set up with A hosting company. On a server you run yourself, add them to the folder yourself.

1. Open the server and select the Plugins or Mods tab.
2. Select Browse and search for what you want.
3. Select Install. Anything it needs is installed with it.
4. Select Restart in the bar at the top of the tab to apply your changes.

From Installed, you can Update or remove what is already there. Changes apply at the next restart.

Join a modded server

If a Fabric or NeoForge server needs mods on your game too, its Server Info tab shows Mods needed to join.

1. Select How to join.
2. Get the Modrinth App and download the mod pack.
3. In the Modrinth App, select +, then Create instance, then Upload a modpack, and pick the file.
4. Select Play, then join the server through Multiplayer using the server address.

Prefer to install mods by hand? Open Rather install the mods by hand? for a list of each mod with its Modrinth link.

Notifications

Select Notifications on the dashboard and pick a Server. Notifications are set separately for each server.

Notification	Who	On by default
Player joins	Everyone	No
Whitelist approved	Everyone	Yes
Whitelist requests	Server managers	Yes
Server status	Server managers	No
Plugin updates	Server managers	No
Channel permission alerts	Server managers	No

Channel permission alerts applies to all servers, and shows a banner on the dashboard instead of a notification.

Link your Minecraft account

Link your account so Command Block knows which player is you. You won't get notifications about your own joins.

1. Select Link account on the dashboard.
2. Select Link a Minecraft Account.
3. Join one of your community's servers and type the /rootlink command shown, including the code.

The code lasts ten minutes. If it runs out, select Get a New Code.

Hide your location

With a linked account, turn off Show my location on the Players or Map tab to hide your coordinates and map marker from everyone. This applies on every server in the community.

Update Root Companion

When a new version of Root Companion is ready, server managers see Plugin Update Available on the server page.

1. Select Update Now.
2. When asked, select Restart Now, or Restart Later to apply it at your next restart.

If Root can't update it automatically, it asks for your SFTP Password, or explains how to replace the plugin file yourself.

Run a console command

Members with Console Access can run commands from the Console tab. Commands run as the server console.

1. Open a server from the dashboard.
2. Select the Console tab.
3. Type a command in the field at the bottom.
4. Press Enter or select Send.

The output appears in the console above. For safety, stop, restart, reload, op, deop and ban-ip can't be run from Command Block.

View the map

Members with Map Access can view a live world map.

1. Open a server from the dashboard.
2. Select the Map tab.
3. Pan and zoom the map. Player markers show where each online player is.

If Squaremap is not installed yet, a server manager can select Install Squaremap. The map needs a server restart to turn on, so you are asked to Restart Now or Restart Later. If the install doesn't work, use Or install manually: copy the Squaremap link to download it from Modrinth yourself.

The map starts blank after Squaremap is first installed. Tiles fill in as players explore the world, and areas no one has visited stay empty.

tip

If the map appears empty or is missing areas, run /squaremap fullrender minecraft:overworld from the server console to draw all existing areas. This can take a while on large worlds and uses extra server resources while it runs.

Edit a player's inventory

Members with Inventory Managers can select Inventory next to an online player on the Players tab. The inventory updates live, and you can add, move or delete items. Only one person can edit a player's inventory at a time. Others see a lock showing who has it open. On Fabric and NeoForge servers you can view the inventory but not edit it.