Usage Notes and Troubleshooting
Usage Notes
Accessing GUIs: GUIs are accessed via commands (e.g.,
/claim menu
forMAIN_MENU
) or by interacting with flags (e.g., clickingClaimIcon
to openICON_SELECTOR
orChangeBiome
to openClaimUpgradeBiomeSelector
).Custom GUIs: Default custom GUIs (e.g.,
ICON_SELECTOR
) dynamically populate items and require a matching section initems
. User-defined custom GUIs (e.g.,ClaimUpgradeBiomeSelector
) are added inconfig.yml
and loaded from_EN
-suffixed files.Themes: Apply themes via the
theme
field in the GUI’sdata
section (e.g.,clean_4
forClaimUpgradeNoEnter
). Custom themes can be created by adding<theme_name>_EN.yml
files.Customization: Admins can modify
menu_title
,rows
,args
,theme
, item properties, andconfig.yml
settings to tailor the GUI experience.Placeholders: Use placeholders (e.g.,
%gpextension_getbyid_flags_parma_ChangeBiome_{claimid}%
,<itemname>
) to display dynamic information.Navigation: Multi-page GUIs include
Previous
andNext
sections for easy navigation, typically in slots47
and51
.
Troubleshooting
GUI Not Opening: Verify that the GUI file exists and is correctly formatted. For custom GUIs, ensure they are listed in
config.yml
undergui.custom_guis
and the file name ends in_EN
(e.g.,ClaimUpgradeBiomeSelector_EN.yml
). Check for errors in the server console.Theme Not Applied: Ensure the
theme
field in the GUI’sdata
section matches a<theme_name>_EN.yml
file in the theme folder (e.g.,default_EN.yml
). Verify the theme file’s syntax.Items Not Displaying: Ensure
slot
is a valid integer (0–53 for a 6-row GUI) orslots
is a valid list of integers, and thatview_requirement
conditions are met. Check that GUI item priorities are lower than theme item priorities (e.g.,1
or2
vs.5
).Navigation Not Working: Confirm that
Previous
andNext
sections are defined in theitems
section for multi-page GUIs, typically in slots47
and51
.Dynamic Items Missing: For default custom GUIs, confirm that the required section (e.g.,
ICON_SELECTOR
) is present initems
.Commands Not Executing: Check that
left_click_commands
,right_click_commands
, orclick_commands
are correctly defined and use valid syntax.Broken GUI: Avoid editing
version
orgui_type
in thedata
section for default GUIs. For custom GUIs, ensuregui_type
matches thecustom_guis
entry.Disabled GUIs: If a GUI is disabled in
config.yml
(disabled_guis
), use thegpgui.bypass.guidisabled
permission to access it.
Last updated