# GeyserMenu Companion<\/p>\n
The server-side half of the GeyserMenu stack.
\nConnects to the GeyserMenu Geyser extension over TCP and exposes a clean Java API for
\nregistering menu buttons, sending native Bedrock forms, and listening to Bedrock player events \u2014
\non both Spigot\/Paper and Velocity.<\/p>\n
## How It Works<\/p>\n
Once connected to the GeyserMenu extension, your plugins use the companion API to register
\nbuttons that appear in the Bedrock menu. When a player clicks a button, the event is
\nforwarded to your plugin’s handler. You can also send forms directly to any Bedrock player
\nat any time.<\/p>\n
## Features<\/p>\n
– **Button registration API** \u2014 register buttons with icons, priorities, and click handlers
\n– **Form builder API** \u2014 send simple, modal, and custom forms to Bedrock players
\n– **Permission-based visibility** \u2014 conditionally show buttons based on player permissions
\n– **Bedrock player events** \u2014 listen for Bedrock join\/leave, check if a player is Bedrock
\n– **Multi-platform** \u2014 supports Spigot\/Paper and Velocity from a single codebase
\n– **Auto-reconnect** \u2014 automatically reconnects to the GeyserMenu extension on disconnect
\n– **Command buttons** \u2014 register buttons that execute commands without writing click handlers<\/p>\n
## Requirements<\/p>\n
– Spigot\/Paper **1.20.4+** or Velocity **3.3.0+**
\n– Java **21+**
\n– Floodgate
\n– GeyserMenu extension running on Geyser<\/p>\n
## Installation<\/p>\n
1. Download the JAR for your platform \u2014 `Spigot` or `Velocity`
\n2. Place it in your `plugins\/` folder
\n3. Start the server once to generate `config.yml`
\n4. Set the `host`, `port`, and `secret-key` to match your GeyserMenu extension config
\n5. Restart \u2014 the plugin will connect and sync buttons automatically<\/p>\n
## Configuration
\n“`yaml
\nextension:
\n host: “localhost”
\n port: 19133
\n secret-key: “your-secret-key-here”<\/p>\n
connection:
\n auto-reconnect: true
\n reconnect-delay: 5<\/p>\n
server:
\n identifier: “lobby”
\n“`<\/p>\n
## Quick API Example
\n“`java
\nGeyserMenuAPI api = GeyserMenuAPI.getInstance();<\/p>\n
api.registerButton(MenuButton.builder()
\n .id(“myplugin-main”)
\n .text(“My Plugin”)
\n .imageUrl(“https:\/\/example.com\/icon.png”)
\n .priority(50)
\n .onClick((player, session) -> openMenu((Player) player))
\n .build());
\n“`<\/p>\n
Full API documentation is available on the GitHub repository.<\/p>\n
## Links<\/p>\n
– GeyserMenu Extension
\n– GitHub
\n– Report Issues<\/p>\n","protected":false},"excerpt":{"rendered":"
Server-side companion plugin for GeyserMenu \u2014 register buttons, send Bedrock forms, and handle player events via a simple API on Spigot\/Paper or Velocity.<\/p>\n","protected":false},"featured_media":75455,"template":"","meta":{"_minecraft_slug":"geysermenu-companion","_minecraft_project_id":"CXrfbCPD","_minecraft_author":"dronzer-tb","_minecraft_license":"GPL-3.0-or-later","_minecraft_downloads":100,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"geysermenu-companion.zip","_minecraft_size_bytes":4685525,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T19:44:50.164101Z","_minecraft_date_created":"2026-03-17T00:56:30.677628Z","_minecraft_date_modified":"2026-03-15T18:13:33.727559Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/geysermenu-companion","_minecraft_icon_attachment_id":75455,"_minecraft_imported_at":"2026-06-04T08:57:25+00:00","_minecraft_import_hash":"735427ef6e6c0b08ed3843b7056af026","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,127,128,129],"mod_loader":[130,132,133,134],"minecraft_version":[59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-75454","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_loader-bukkit","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n