RegionGui

RegionGUI

A comprehensive region management plugin for Spigot/Paper servers with an intuitive GUI-based interface for managing WorldGuard regions.

Features

• Region Browser - Browse all your regions with pagination support
• Region Management - View detailed region information including coordinates, volume, and member count
• Flag Management - Easily toggle and configure WorldGuard flags with 45 flags per page
• Member Management - Add, remove, and manage member roles for your regions
• Region Transfer - Transfer ownership of regions to other players
• Region Deletion - Delete regions with confirmation protection
• Member Invitations - Invite players to join your regions with customizable roles
• Search & Filter - Search regions and flags by name with real-time filtering
• Sorting Options - Sort regions by name, members, or volume; sort flags A-Z or Z-A
• Category Filtering - Filter flags by category (Protection, Gameplay, Mob/Fire/Explosion, Natural Events, Movement)
• Role System - Customizable role system for region members
• Pagination - Efficient pagination for large numbers of regions and flags
• Mobile Friendly GUI - Optimized 54-slot inventory interface with clear navigation

Installation

1. Download the plugin JAR file
2. Place it in your server's plugins folder
3. Ensure WorldGuard is installed and enabled
4. Restart your server
5. Configuration files will be generated in plugins/RegionGUI/

Commands

Main Commands

Management Commands

Member Commands

Permissions

Configuration

Main Configuration (config.yml)

Customize colors, messages, roles, and flag categories:

# Region colors
colors:
  owner: '#FFD700'
  manager: '#87CEEB'
  member: '#90EE90'

# Role display names
roles:
  owner:
    displayName: 'Owner'
  manager:
    displayName: 'Manager'
  member:
    displayName: 'Member'

# Flag categories for filtering
flag-categories:
  protection:
    - deny-spawn
    - creeper-explosion
    - tnt
  gameplay:
    - pvp
    - item-drop
    - invincibility
  # ... more categories

GUI Configuration (maingui.yml & manageflags.yml)

Customize the appearance and layout of inventory GUIs:

menu_title: '&8&lMy Regions'
size: 27

items:
  previous_page_button:
    material: ARROW
    slot: 21
    display_name: '&fPrevious Page'
  
  search_button:
    material: OAK_SIGN
    slot: 22
    display_name: '&aSearch'
  
  next_page_button:
    material: ARROW
    slot: 23
    display_name: '&fNext page'

Messages (messages.yml)

All user-facing messages are customizable with color support:

region-selected: '&8Selected region: &e%region%'
flag-updated: '&8Successfully updated flag &e%flag% &8to &f%value%&8.'
member-added: '&8Added &e%player% &8as a &b%role% &8to region &e%region%&8.'

GUI Walkthrough

Region Browser (27 slots)

• Slots 0-17: Your regions displayed as items
• Slot 21: Previous page button
• Slot 22: Search button with current search status
• Slot 23: Next page button

Flag Management (54 slots)

• Slots 0-44: Region flags with current values and states
• Slot 45: Previous page button
• Slot 46: Back to manager button
• Slot 48: Sort toggle (A-Z / Z-A)
• Slot 49: Search button
• Slot 50: Filter button (by category)
• Slot 53: Next page button

Member Management (54 slots)

• Slots 0-8: Top border
• Slots 9-44: Region members with their roles
• Slot 45: Previous page button
• Slot 46: Search members button
• Slot 48: Back to manager button
• Slot 49: Add member button
• Slot 53: Next page button

How to Use

Viewing Your Regions

1. Run /region to open the Region Browser
2. Use the Previous/Next arrows to browse through pages
3. Click on a region to view its details

Managing Flags

1. Select a region and click "Manage Flags"
2. Use the Filter button to view specific flag categories
3. Use the Sort button to organize flags
4. Left-click a flag to toggle its state
5. Right-click a flag to clear it

Adding Members

1. In the Region Manager, click "Manage Members"
2. Click the Emerald button to add a new member
3. Enter the player's name in chat
4. Select the role for the new member

Managing Roles

1. In the Members list, click on a member
2. Left-click to change their role
3. Right-click to remove them from the region

Placeholders

If PlaceholderAPI is installed, you can use these placeholders:

• %regiongui_region_count% - Number of regions owned by player
• %regiongui_active_region% - Currently selected region name
• %regiongui_member_count% - Number of members in active region

Support & Reporting Issues

If you encounter any issues or have feature requests:

1. Check the configuration files are correct
2. Ensure WorldGuard is properly installed
3. Check server logs for error messages
4. Verify player permissions are set correctly

Dependencies

• Required: WorldGuard 7.0+
• Optional: PlaceholderAPI (for placeholder support)

Compatibility

• Spigot 1.16+
• Paper 1.16+
• Tested up to Minecraft 1.20.4

License

This plugin is provided as-is. All rights reserved.

Credits

Developed for efficient WorldGuard region management on Spigot/Paper servers.

Note: This plugin requires WorldGuard to function. Make sure WorldGuard is properly installed and configured on your server before using RegionGUI.