GUI Walkthrough
Complete guide to HyperFactions' graphical user interface.
GUI Walkthrough
HyperFactions provides an intuitive GUI for managing factions without memorizing commands. This guide walks through every screen and feature available in the GUI.
Opening the GUI
Access the main faction GUI with:
/f
This opens the main dashboard if you're in a faction, or the faction browser if you're not.
Permission Required
You need the hyperfactions.use permission to open the GUI.
Main Dashboard
The main dashboard is your faction's control center. It shows an overview of your faction and provides quick access to all features.
Screenshot Needed
Screenshot: faction-main-dashboard.png
Description: Main faction dashboard showing overview panel with faction name, power, claims, and member count
Key elements to capture:
- Faction name and tag at the top
- Power bar showing current/max power
- Claims counter showing used/available
- Member list preview
- Quick action buttons (Home, Map, Chat)
- Navigation buttons to other sections
Dashboard Sections
| Section | Description |
|---|---|
| Header | Faction name, tag, and color |
| Power Display | Current power / max power with visual bar |
| Claims Display | Current claims / max claims |
| Treasury Display | Current faction balance (if economy enabled) |
| Member Preview | Online members with status indicators |
| Quick Actions | Home teleport, map view, chat mode toggle |
| Navigation | Buttons to Members, Relations, Settings, Treasury, etc. |
Quick Actions
| Button | Action | Permission |
|---|---|---|
| Home | Teleport to faction home | hyperfactions.teleport.home |
| Map | Open territory map | hyperfactions.territory.map |
| Chat | Cycle chat mode (Normal/Faction/Ally) | hyperfactions.chat.faction |
| Leave | Leave the faction | hyperfactions.member.leave |
Faction Browser
The faction browser lets you view all factions on the server.
Screenshot Needed
Screenshot: faction-browser.png
Description: Faction browser showing list of all factions with sorting options
Key elements to capture:
- List of faction cards with name, power, member count
- Sort buttons (by name, power, members, age)
- Search/filter field
- Join/request button on open factions
- Faction info preview on hover
Browser Features
- Search: Filter factions by name
- Sort: Order by name, power, members, or creation date
- Pagination: Navigate through large faction lists
- Status indicators: Open (green) vs Closed (red) factions
Viewing Faction Details
Click any faction to see detailed information:
| Field | Description |
|---|---|
| Description | Faction's custom description |
| Power | Total faction power |
| Claims | Number of claimed chunks |
| Members | Total member count |
| Leader | Current faction leader |
| Created | When the faction was founded |
| Relations | Allied and enemy factions |
Joining a Faction
Open Factions: Click "Join" to join immediately.
Closed Factions: Click "Request" to send a join request. The faction's officers or leader must approve it.
Join Requests
Join requests expire after 24 hours by default. Check back with the faction if you don't hear back.
Territory Map
The territory map provides a visual overview of claimed territory in your area, with optional terrain imagery mode for realistic map display.
Screenshot Needed
Screenshot: chunk-map.png
Description: Visual territory map showing chunks with color-coded ownership
Key elements to capture:
- Grid of chunks centered on player position
- Color coding: your faction, allies, enemies, neutral, wilderness
- Player position marker
- Legend showing what colors mean
- Terrain imagery toggle button
- Claim/unclaim buttons for current chunk
Screenshot Needed
Screenshot: chunk-map-terrain.png
Description: Territory map in terrain imagery mode showing actual world terrain textures
Key elements to capture:
- Same grid layout with terrain textures overlaid
- Faction borders visible over terrain
- Toggle button to switch back to standard mode
Map Colors
| Color | Meaning |
|---|---|
| Your Color | Your faction's territory |
| Green | Allied faction territory |
| Red | Enemy faction territory |
| Yellow | Neutral faction territory |
| Gray | Unclaimed wilderness |
| Bright Green | SafeZone |
| Bright Red | WarZone |
Map Controls
- Pan: Click and drag to move the map
- Center: Button to re-center on your position
- Terrain Toggle: Switch between standard and terrain imagery mode
- Claim: Claim the chunk you're standing in
- Unclaim: Release the chunk you're standing in
Map Visibility
The map respects faction visibility settings. Factions can control whether they appear on the map to different relation types. Enemy territory may be hidden depending on server configuration.
Map Symbols
| Symbol | Meaning |
|---|---|
| You | Your current position |
| H | Faction home location |
| S | SafeZone |
| W | WarZone |
Member Management
The members page shows all faction members and their status.
Screenshot Needed
Screenshot: faction-members.png
Description: Member management interface showing all members with roles and actions
Key elements to capture:
- Member list with online/offline status
- Role indicators (Leader, Officer, Member)
- Power display per member
- Last seen timestamp for offline members
- Action buttons (promote, demote, kick)
- Pending invites section
- Pending join requests section
Member List
| Column | Description |
|---|---|
| Name | Player name with online indicator |
| Role | Leader, Officer, or Member |
| Power | Current personal power |
| Last Seen | When offline members were last active |
Member Actions
Actions available depend on your role:
As Leader:
- Promote Members to Officer
- Demote Officers to Member
- Kick any member
- Transfer leadership
As Officer:
- Kick Members (not other Officers)
As Member:
- View only (no management actions)
Invitations
The invitations panel shows:
- Pending Invites: Players you've invited who haven't responded
- Join Requests: Players who want to join your faction
For Leaders/Officers
Don't forget to check join requests regularly! Players are waiting for your approval.
Relations Page
The relations page manages your faction's diplomatic relationships. It uses a 2-tab layout for easy navigation.
Screenshot Needed
Screenshot: faction-relations.png
Description: Relations management with 2-tab layout (Relations / Pending)
Key elements to capture:
- Relations tab: Active ally and enemy factions with relation badges
- Pending tab: Incoming and outgoing ally requests
- Faction cards with name, power, member count, and relation status
- Set Relation buttons (Ally/Enemy/Neutral)
- Max allies/enemies indicators
Relation Types
| Relation | Effect |
|---|---|
| Ally | Cannot damage, friendly chat, green on map |
| Enemy | Can overclaim, always hostile, red on map |
| Neutral | Default state, yellow on map |
Managing Relations
To Ally:
- Click "Send Ally Request" on a faction
- Wait for them to accept
- Alliance is mutual when both accept
To Enemy:
- Click "Declare Enemy" on a faction
- Immediate effect (no confirmation needed)
To Reset:
- Click "Set Neutral" on any faction
- Removes ally or enemy status
Alliance Limits
Your server may limit maximum allies (default: 10). Check the relations page header for your current/max count.
Faction Settings
The settings page lets leaders customize their faction.
Screenshot Needed
Screenshot: faction-settings.png
Description: Faction settings page with customization options
Key elements to capture:
- Faction name field
- Tag/abbreviation field
- Description text area
- Color picker or color codes
- Open/Closed toggle
- Territory permission settings
- Save/Cancel buttons
General Settings
| Setting | Description | Permission |
|---|---|---|
| Name | Faction display name | hyperfactions.faction.rename |
| Tag | Short tag shown in chat | hyperfactions.faction.tag |
| Description | Faction description | hyperfactions.faction.description |
| Color | Display color | hyperfactions.faction.color |
| Open/Closed | Whether anyone can join | hyperfactions.faction.open/close |
Territory Permissions
Control what different groups can do in your territory:
| Group | Description |
|---|---|
| Members | Your faction members |
| Allies | Allied faction members |
| Neutrals | Neutral faction members |
| Enemies | Enemy faction members |
| Permission | Description |
|---|---|
| Build | Place and break blocks |
| Interact | Use doors, buttons, levers |
| Container | Access chests and storage |
Default Territory Permissions
By default, only faction members can build and access containers in your territory. Allies can usually interact with doors.
Treasury Page
The treasury page manages your faction's finances (requires VaultUnlocked).
Screenshot Needed
Screenshot: faction-treasury.png
Description: Treasury management page showing balance, transactions, and actions
Key elements to capture:
- Current balance display
- Deposit and withdraw buttons with amount input
- Transaction history log
- Transfer to other factions option
- Permission indicators for economy actions
Treasury Actions
| Action | Permission | Description |
|---|---|---|
| View Balance | hyperfactions.economy.balance | See faction treasury balance |
| Deposit | hyperfactions.economy.deposit | Add money to treasury |
| Withdraw | hyperfactions.economy.withdraw | Take money from treasury |
| Transfer | hyperfactions.economy.transfer | Send money to another faction |
| View Log | hyperfactions.economy.log | See transaction history |
Player Info Page
View detailed information about any player on the server.
Screenshot Needed
Screenshot: player-info.png
Description: Player information card showing faction, power, and activity
Key elements to capture:
- Player name and avatar
- Current faction and role
- Personal power (current/max)
- Online/offline status
- Faction membership history
Chat History Page
Browse your faction's chat history with scrollable message log.
Screenshot Needed
Screenshot: chat-history.png
Description: Chat history page showing scrollable faction and alliance chat messages
Key elements to capture:
- Scrollable message list
- Timestamps on messages
- Player names with role indicators
- Chat channel filter (Faction/Ally)
Admin Dashboard
Server administrators have access to additional management features.
For Server Admins
The admin dashboard requires hyperfactions.admin.use permission.
Screenshot Needed
Screenshot: admin-dashboard.png
Description: Admin dashboard showing server-wide faction management
Key elements to capture:
- Faction list with management buttons
- Zone management section
- Server statistics (total factions, claims, etc.)
- Config reload button
- Debug toggle
- Backup management
Admin Features
| Feature | Permission | Description |
|---|---|---|
| Force Disband | hyperfactions.admin.disband | Delete any faction |
| Modify Faction | hyperfactions.admin.modify | Edit any faction's settings |
| Zone Management | hyperfactions.admin.zones | Create/edit SafeZones and WarZones |
| Reload Config | hyperfactions.admin.reload | Reload configuration files |
| Debug Mode | hyperfactions.admin.debug | Toggle debug output |
| Backup Management | hyperfactions.admin.backup | Create and restore backups |
Zone Management
Screenshot Needed
Screenshot: admin-zones.png
Description: Zone management interface for creating and editing SafeZones and WarZones
Key elements to capture:
- List of existing zones with type indicators
- Zone creation form
- Flag toggles for each zone
- Chunk selection/radius tools
- Delete zone button
The zone management interface allows:
- Creating named SafeZones and WarZones
- Claiming chunks for zones
- Configuring the 25 zone flags (including 4 that require OrbisGuard-Mixins)
- Changing zone types
- Deleting zones
See Zones for detailed flag information.
Admin Players Page
Screenshot Needed
Screenshot: admin-players.png
Description: Admin player management showing all players with power and faction info
Key elements to capture:
- Player list with search/filter
- Power display per player
- Faction membership info
- Power modification controls
- Player history
Admin Economy Page
Screenshot Needed
Screenshot: admin-economy.png
Description: Admin economy management for faction treasuries
Key elements to capture:
- Faction treasury overview
- Balance modification controls
- Transaction history viewer
- Economy statistics
GUI Keyboard Shortcuts
| Key | Action |
|---|---|
| Escape | Close current GUI |
| Tab | Navigate between sections |
Accessibility
The GUI is designed with accessibility in mind:
- High contrast colors for readability
- Clear labels on all buttons
- Tooltips for additional information
- Keyboard navigation support
Troubleshooting
GUI Won't Open
- Check you have
hyperfactions.usepermission - Ensure HyperFactions is loaded (
/f version) - Check server console for errors
Buttons Not Working
- Verify you have the required permission
- Check if you have the correct faction role
- Some actions require Leader or Officer role
Display Issues
- Try closing and reopening the GUI
- Check if your client has UI scaling issues
- Report persistent issues with screenshots
Related Topics
- Basic Commands - Command alternatives to GUI
- Economy - Treasury system details
- Roles - Understanding faction roles
- Permissions - Permission requirements
- Zones - Zone flag details