Geysermc Bedrock - Phoenix Lobby - Docs

GeyserMC (Bedrock)

On this page

Overview
How the Forms Work
Forms
Input Modes
Allow Opt Out
Resize Chest Menus
Chest Only Menus
Icons

These options are in the bedrock section of config.yml. They have no editor option.

#Overview

Bedrock players joining through Geyser can use the lobby menus as native Bedrock forms instead of chest menus: a list of buttons for the selectors and a list of switches for the player settings. Forms need Floodgate or Geyser to be installed on the same server as the plugin. Without either, everyone gets the chest menus.

Please note: This guide will not cover the installation process of Geyser itself. Refer to the Geyser wiki for comprehensive installation instructions: Geyser Wiki Setup

YAML

bedrock:
  forms: true
  input-modes: []
  allow-opt-out: true
  resize-chest-menus: true
  chest-only-menus: []
  icons:
    enabled: true
    fallback-url: ""
    head-url: "https://mc-heads.net/head/%texture%"

#How the Forms Work

Menu	Bedrock form
Server selector and custom menus	A button per item that has actions, in slot order.
Lobby selector	A button per lobby with its player count, then the menu's other items. The lobby you are in and offline lobbies do nothing.
Music	The menu's items, such as the stop button, then a button per disc.
Player settings	A switch per setting, saved when the form is submitted.

Buttons use the display name of each item, with colors and placeholders kept and hex colors removed, since forms cannot show them. Items without actions, fillers and close buttons are left out. The text around them, such as the lobby player count, comes from the bedrock section of the translations file.

The actions of an item and the open actions of a menu still run. Everything else about the chest menu layout does not apply to forms.

If a form cannot be sent, the player gets the chest menu instead and the console says so.

Admin menus such as the editor stay chest menus. A button with more than one click action asks the Bedrock player which one to run, and every text prompt opens as a form.

#Forms

Turns Bedrock forms on or off for the whole server. When off, Bedrock players get the chest menus like everyone else.

#Input Modes

Limits forms to Bedrock players on certain devices, by their input mode: TOUCH, CONTROLLER, KEYBOARD_MOUSE or VR. Players on any other input get chest menus. Leave the list empty to give forms to every Bedrock player.

YAML

bedrock:
  input-modes:
  - TOUCH
  - CONTROLLER

#Allow Opt Out

Lets Bedrock players choose chest menus for themselves. Every form gets a button, or a switch in the player settings, to change to chest menus, and /plobby forms switches between the two. The choice is remembered per player. When this is off, every Bedrock player gets forms and the command is refused.

#Resize Chest Menus

Bedrock only draws chest menus of 3 or 6 rows cleanly. With this on, a menu of 1 or 2 rows is opened with 3 rows and a menu of 4 or 5 rows with 6, for Bedrock players who get chest menus. Java players always see the rows the menu is set to.

#Chest Only Menus

Menus that always open as chest menus, by file name without .yml: servers, lobbies, music, player-settings or one of your own. Use it for a menu that shows information rather than buttons, since a form only shows the items that have actions.

YAML

bedrock:
  chest-only-menus:
  - profile

#Icons

Adds an icon to form buttons.

enabled - Turns icons on or off.
fallback-url - An image URL for materials the built-in icon table does not know. %material% is replaced by the material name in lower case. Leave it empty for no icon.
head-url - An image URL for player heads. %texture% is replaced by the head's texture id, or the owner's name when it has no texture. Leave it empty for no head icons.

Vanilla items use the Bedrock texture of the same item, which every Bedrock client already has. Custom items, meaning items from another plugin, items with custom model data and items with an item model, get no icon, since their texture only exists in a resource pack. Player heads always use the head URL.