Menus in game

A page in /relay

Players type /relay in game, with or without cheats. It lists every installed plugin that declares a menu, and opens the page they choose. With only one, it opens straight away.

import { ActionFormData } from "@minecraft/server-ui";

export default {
  id: "warps",
  name: "Warps",
  version: "1.0.0",
  description: "Teleport to the server's warps.",
  menu: {
    name: "Warps",
    async open(player) {
      const form = new ActionFormData().title("Warps").button("Spawn").button("Market");
      const chosen = await form.show(player);
      if (chosen.canceled) return;
      player.teleport(chosen.selection === 0 ? { x: 0, y: 70, z: 0 } : { x: 120, y: 64, z: -40 });
    },
  },
  commands: [],
};

A plugin can have a menu, Discord commands or both. One with only a menu has commands: [].

Forms

Both BedrockRelay packs load @minecraft/server-ui, so your plugin can import ActionFormData, ModalFormData and MessageFormData from it like any addon. On a Realm it's the stable version, without Beta APIs.

The player has just typed in chat, so the first form may be cancelled with FormCancelationReason.UserBusy while the chat screen closes. Show it again a few ticks later:

import { system } from "@minecraft/server";
import { FormCancelationReason } from "@minecraft/server-ui";

async function show(form, player) {
  for (let tries = 0; tries < 40; tries++) {
    const response = await form.show(player);
    if (response.cancelationReason !== FormCancelationReason.UserBusy) return response;
    await new Promise((resolve) => system.runTimeout(resolve, 5));
  }
  return { canceled: true };
}

Versions

Menus need pack v0.10.0 on a dedicated server and Realm pack v1.5.0. Set minPackVersion (and minRealmPackVersion for Realms) so the dashboard asks for the update before installing your plugin. On an older pack there's no /relay in game, and the rest of your plugin works as before.