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 | Command | Description | Permission | |---------|-------------|-----------| | `/region` | Open the region browser GUI | `regiongui.use` | | `/region page <prev\|next>` | Navigate between region pages | `regiongui.use` | | `/region search <query>` | Search for regions by name | `regiongui.use` | | `/region reload` | Reload all configurations (Admin only) | `regiongui.admin` | ### Management Commands | Command | Description | Permission | |---------|-------------|-----------| | `/region manage <region>` | Open region management GUI | `regiongui.manage` | | `/region flags <region>` | View and edit region flags | `regiongui.flags` | | `/region members <region>` | Manage region members | `regiongui.members` | | `/region transfer <region> <player>` | Transfer region ownership | `regiongui.transfer` | | `/region delete <region>` | Delete a region | `regiongui.delete` | ### Member Commands | Command | Description | Permission | |---------|-------------|-----------| | `/region invite <player> <region>` | Invite a player to your region | `regiongui.invite` | | `/region accept <region>` | Accept a region invitation | `regiongui.use` | | `/region deny <region>` | Decline a region invitation | `regiongui.use` | ## Permissions | Permission | Description | Default | |-----------|-----------|---------| | `regiongui.use` | Access basic region GUI features | true | | `regiongui.manage` | Manage region settings | true | | `regiongui.flags` | Edit region flags | true | | `regiongui.members` | Manage region members | true | | `regiongui.transfer` | Transfer region ownership | true | | `regiongui.delete` | Delete regions | true | | `regiongui.invite` | Invite players to regions | true | | `regiongui.admin` | Admin commands (reload configs) | op | ## Configuration ### Main Configuration (config.yml) Customize colors, messages, roles, and flag categories: ```yaml # 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: ```yaml 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: ```yaml 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)