BedrockGUI Plugin for Spigot, Paper, Bungeecord, and their Forks!

BedrockGUI is a simple yet powerful plugin that allows server owners to create custom GUI menus for Bedrock players on Java servers via Geyser. Using the Floodgate API, this plugin offers seamless interaction for Bedrock players through custom forms and menus.

---

Features

• Custom GUIs for Bedrock players: Design interactive menus for players using Simple, Modal, or Custom forms.
• Support for SimpleForm, ModalForm, and CustomForm: Build menus for choices, confirmations, or advanced inputs.
• Seamless Geyser and Floodgate Integration: Automatically handle Bedrock player interactions.
• YAML-Based Configuration: Easily define menus, buttons, and actions without coding.
• Developer API: Extend or create menus programmatically for advanced use cases.
• PlaceholderAPI Support: Add dynamic placeholders to buttons and forms (optional).

---

Requirements

• Minecraft Server: Paper, Spigot, or compatible forks.
• Proxy Support: Bungeecord or its forks (optional).
• Floodgate: Required for Bedrock player detection.
• (Optional) PlaceholderAPI for dynamic placeholders.
• Java 17+: Required for the plugin to function.

---

Installation

1. Download the plugin JAR from the Spigot page or build it from source (instructions below).
2. Place the JAR file in your server's plugins folder.
3. Restart your server to generate the default config.yml file.
4. Edit the config.yml file to define your menus.
5. Run /bgui reload (or /bguiproxy reload on BungeeCord) to apply changes without restarting the server.

---

Compiling from Source

If you'd like to build your own version of BedrockGUI, follow these steps:

Prerequisites

• Java Development Kit (JDK) 17 or later.
• Gradle build tool.

Steps to Build

1. Clone the repository:

   git clone https://github.com/your-username/your-repo.git
   cd your-repo

2. Build the plugin using Gradle's shadowJar task:

   ./gradlew shadowJar

3. Copy the generated JAR file from the build/libs/ directory into your server's plugins folder.

Customizing

Modify the source code to add features or change functionality, then re-run the shadowJar task to generate an updated JAR.

---

Commands

Command	Description
/bgui reload	Reload all menus from the configuration.
/bgui open <menu_name>	Open a specific menu for yourself.
/bgui openfor <player> <menu_name>	Open a menu for another player.

---

Support

For help or questions, join our Discord Server or check out the Wiki Documentation.

---

License

This project is licensed under the GNU General Public License v3.0.