BetterGUI Plugin Wiki › FAQ
BetterGUI Plugin FAQ
10 questions players actually ask, answered.
How do I make my first menu in BetterGUI?
Create a new .yml file in the plugin's menu folder (the file name becomes the menu name). Define the menu settings such as title and rows, add buttons with an item, name and lore, then reload the plugin and open it in-game.
How do I open a menu I made?
Use the plugin's open-menu command with your menu's file name, for example /openmenu yourmenu. You can also give the menu its own command in the menu settings so players can type something short like /shop.
How do I make a button run a command when clicked?
Add a command section to the button and list the commands there. A prefix chooses who runs it: for example console: runs it as the server and player: runs it as the clicking player. Without a prefix it runs as the player by default.
Can a button send a message or play a sound?
Yes. Use the message-style action (such as tell:) to send text to the player and the sound action to play a sound by its Minecraft sound name. You can stack several actions in the same button's command list, and they run in order.
How do I close the menu after clicking a button?
Add the close action to the button's command list, usually as the last entry. Otherwise the menu stays open after the click, which is handy for pages or toggles but annoying for a simple shop button.
How do I show the player's name or stats in a menu?
Install PlaceholderAPI and download the expansion you need, such as the Player one. Then put placeholders like %player_name% in a button's name or lore, and they are replaced with live values when the menu is shown.
My placeholders show as raw text like %player_name%. What's wrong?
Usually PlaceholderAPI isn't installed, or the matching expansion hasn't been downloaded and registered. Check with /papi list, download the expansion, reload PlaceholderAPI, then reload the menu.
I edited my menu file but nothing changed in-game. How do I reload it?
Run the reload subcommand of the main command, /bettergui reload, then reopen the menu. Menus that were already open keep the old layout until closed and reopened.
My menu won't load or buttons are missing. What are the common mistakes?
The most frequent cause is YAML formatting: tabs instead of spaces, bad indentation, or a missing colon or quote. Also check for typos in item or sound names and for buttons placed in a slot outside the menu's row count, and read the console for the error on reload.
Will lots of menus hurt my server's performance?
The plugin is lightweight, and menus that are not open cost very little. Keep an eye on menus that refresh constantly or use many heavy placeholders, since those are re-evaluated for every viewer.