Claim GUI

Claim GUI

GPExpansion includes an optional GUI system for managing claims. When enabled, many commands open interactive menus instead of chat output.

Enabling GUI Mode

In config.yml:

gui:
  enabled: true

Requires server restart to take effect.

Main Menu (/claim)

When GUI is enabled, running /claim opens the main menu with:

• My Claims - Browse your claims with icons and details
• Global Claims - View public global claims
• Claim Map - Visual claim editor (if standing in claim)
• Settings - Personal preferences

Claim List GUI (/claim list)

Interactive claim browser showing:

• Claim icon (customizable)
• Claim name (or "Unnamed")
• Claim ID
• Size and coordinates
• Click to view claim details

Claim Details Page

Clicking a claim opens options:

• Teleport - Go to claim spawn
• Manage - Open management menu
• Trust - View and edit trusted players
• Info - Detailed claim information

Claim Map Editor (/claim map)

Visual claim boundary editor with two modes:

Basic Mode

Simple directional expansion/contraction:

• North/South/East/West buttons
• Expand or shrink by set amounts
• Visual feedback on changes

Shaped Mode

Precise corner/boundary editing:

• Click specific points on the map
• Drag to resize boundaries
• Visual representation of claim shape
• See neighboring claims

Trust Management GUI

Visual trust interface:

• List of trusted players by level
• Add/remove players
• Change trust levels
• See when players were added

Management Menus

Claim Management

• Edit name/description
• Set icon
• Set spawn point
• Toggle global status
• View flags (GPFlags)
• Open options

Rental Management

• View active rentals
• Evict renters
• Collect payments
• Rental history

Mailbox Management

• View mailbox status
• Configure mailbox
• Check storage levels
• View deposit history

Global Claims Browser (/claim globallist)

Public claims directory:

• Search by name/description
• Filter by owner
• Sort by various criteria
• Click to view details
• Teleport (if enabled)

GUI Navigation

Return to Previous GUI

Use /claim ! to return to the last viewed GUI with preserved state.

Permission: griefprevention.claim.gui.return

Menu Navigation

• Back button - Return to previous menu
• Next/Prev - Browse paginated lists
• Close - Exit GUI
• Refresh - Update displayed data

GUI Configuration

gui:
  enabled: true
  
  main-menu:
    show-global-claims: true
    show-rental-info: true
    show-tutorial: true
  
  claim-list:
    page-size: 10
    show-coordinates: true
    show-size: true
    show-trust-count: true
  
  colors:
    primary: "&6"      # Gold
    secondary: "&e"  # Yellow
    error: "&c"      # Red
    success: "&a"    # Green
    info: "&b"       # Aqua
  
  sounds:
    open: true
    click: true
    close: true
    error: true

Permission Integration

GUI respects all GPExpansion permissions:

• Options hidden if player lacks permission
• Trust management disabled for non-owners
• Admin features only for admins

Fallback to Chat

If GUI is disabled or fails to load:

• Commands output to chat as normal
• All functionality still available
• No data loss or issues

Supported Versions

GUI requires:

• Paper 1.20+ (recommended)
• Spigot 1.20+ (compatible)
• Folia 1.20+ (compatible)

Troubleshooting

GUI not opening?

• Check gui.enabled in config
• Verify player has griefprevention.claim.gui permission
• Try /gpx reload or server restart

Items appearing wrong?

• Some icons require valid material names
• Invalid icons fall back to default

Lag when opening?

• Large claim lists may take time to load
• Consider using pagination
• Check database connection speed

Tips

• Set custom icons for easy identification
• Use /claim ! to quickly return to where you were
• The claim map is great for visualizing claim boundaries
• Global claims browser helps discover new builds