GeyserMenu

A lightweight and simple Bedrock Edition custom form plugin.

Latest version: v1.2.0

Update Content

• Improve the menu type and permission configuration documentation
• Instructions for optimizing menu configuration
• Correct the terminology in the document ("基岭版" should be uniformly corrected to "基岩版")

Functional Features

Basic functions

• Only supports players of the Bedrock Edition
• Support multiple menu configurations
• Support unlimited levels of submenus
• Supports PlaceholderAPI variables
• Supports two types of icons:
  • Java Edition item ID (using icon_type: "java")
  • Bedrock version material path (using icon_type: "bedrock")
• Integrated BStats statistical function (configurable)

Command system

• Supports three command execution modes:
  • Player execution (execute_as: "player")
  • Console execution (execute_as: "console")
  • OP authority execution (execute_as: "op")

Command List

• /gmenu - Open the default menu
• /gmenu help - Display help information
  /gmenu reload - Reload configuration file (Requires permission: geysermenu.reload)
• /gmenu open <player_name> <menu_name> - Open the menu for the specified player (Requires permission: geysermenu.open)

Permission node

• geysermenu.use - Allow the use of menu commands (default: true)
• geysermenu.reload - Allows reloading of configuration (default: op)
• geysermenu.open - Allows opening the menu for other players (Default: op)
• geysermenu.* - Allows access to all functions (default: op)

Menu Configuration

• Support enabling/disabling menus through config.yml
• Support for customizing menu titles and buttons
• Support for customizing button icons and commands
• • Support for item ID icons (e.g. minecraft:diamond)
• • Support URL icon (using icon_type: "url")
• • Support for custom path icons (using icon_type: "path" and icon_path)
• Support mutual navigation between menus
• Support for menu subtitles and descriptions
• Support button description text
• Support for form footer text
• Support color codes (using § or &)
• Supports multi-line text (using |- syntax)

Icon Support

GeyserMenu supports two types of icons:

1. Item ID in Java Edition

   icon: "diamond_sword"
   icon_type: "java"
   

2. Bedrock Edition material path

   icon: "textures/items/diamond_sword"
   icon_type: "bedrock"
   

All supported Java Edition item IDs will be automatically mapped to their corresponding Bedrock Edition material paths. You can add or modify these mappings in config.yml.

Statistical functions

GeyserMenu integrates the BStats statistical function to collect anonymous plugin usage data, helping developers understand the usage of plugins and improve their quality.

Configuration Options

settings:
  statistics:
    # Whether to enable BStats statistics
    enable-bstats: true
    # Whether to collect custom statistical data
    collect-custom-data: true

Collected Data

• Server version and software type
• Java version information
• Number of online players
• Usage of plug-in functions
• Menu configuration statistics

Privacy Protection

• All data are anonymous
• Do not collect sensitive data such as server IP addresses and player information
• Can be disabled in the configuration at any time