🛠️ GeyserMC (Bedrock)

#Overview

Bedrock players joining through Geyser can use the shop as native Bedrock forms instead of chest menus: a list of buttons for the categories and the items, a slider to pick the amount, and a toggle list to sell from the inventory. 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

bedrock:
  forms: true
  input-modes: []
  allow-opt-out: true
  resize-chest-menus: true
  after-transaction: CATEGORY
  confirm-above: 0
  custom-amount: true
  show-balance: true
  sell-form: true
  icons:
    enabled: true
    fallback-url: ""
    head-url: "https://mc-heads.net/head/%texture%"

#How the Forms Work

Menu	Bedrock form
Main menu	A button per enabled category, showing how many items it holds.
Category menu	A button per item, showing its buy and sell price. An item that can be both bought and sold asks which one first.
Buy and sell menus	A slider from one lot up to as many as fit in the inventory when buying, or as many as the player carries when selling, capped at nine stacks. Items that do not stack are bought one at a time.
Bulk menus	Replaced by the slider form, which already covers up to nine stacks.
Sell menu	A toggle per kind of item in the inventory that a shop buys, all on by default.

Buttons use the display names of the shop, the categories and the items, with colors kept and hex colors removed, since forms cannot show them. The text around them, such as the balance line, the back button and the confirmation, comes from the bedrock section of the translations file.

The actions of the category tile and the open and close actions of a category 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.

#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.

bedrock:
  input-modes:
  - TOUCH
  - CONTROLLER

#Allow Opt Out

Lets Bedrock players choose chest menus for themselves. The main shop form gets a button to switch to chest menus, and /pshop 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.

#After Transaction

Where a Bedrock player goes after a purchase or sale on the slider form goes through.

Value	Goes to
CATEGORY	Back to the category, to pick another item.
TRANSACTION	The same slider form again, to buy or sell more of the item.
CLOSE	Nowhere, the form closes.

A refused transaction always opens the slider form again.

#Confirm Above

A total price from which a purchase or sale asks for confirmation before going through. Anything cheaper goes through straight away. Set it to 0 to never ask.

#Custom Amount

Adds a text field under the slider where the player can type an exact amount. A typed amount wins over the slider, and shorthands such as 1.5k are accepted. An amount that is not a number reopens the form with a message.

#Show Balance

Shows the player's balance at the top of the shop, category and slider forms, in the currency that applies there.

#Sell Form

Replaces the /sell menu chest, where items are dragged in, with a form listing every item in the inventory that a shop buys. The player turns off what they want to keep and submits. When off, Bedrock players get the chest version.

#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.