StaffHelp Documentation

Version 1.5

Overview

StaffHelp is a comprehensive ticket management system for Minecraft servers that enables players to request assistance through multiple specialized channels. Staff members receive notifications and can access intuitive GUI menus to respond to requests with instant teleportation or compass tracking functionality.

Features

• 14 distinct request types covering emergency services, medical assistance, police response, mechanical help, support, and transportation
  
  
• GUI menus displaying player heads with location coordinates and request reasons
  
  
• Real-time compass tracking that updates as players move
  
  
• Automatic compass removal upon reaching destination
  
  
• Asynchronous operations ensuring no server lag
  
  
• Multi-world compatibility
  
  
• Full message customization via configuration file
  
  
• Permission-based access control for all commands
  

Request Types

SOS: General help requests. Staff teleport directly to the requesting player upon accepting.

911: Emergency response. Staff receive a compass pointing to the request location.

QRR: Quick response with real-time player tracking. Compass updates continuously as the player moves.

MEDIC: Medical emergency response. Staff receive a compass to locate the player requiring medical assistance.

912: Alternative emergency channel with compass guidance.

190: Police response channel. Staff receive a compass to the location.

MECANIC: Mechanical assistance for vehicle or equipment issues. Compass points to player location.

SUPPORT: General support requests with compass guidance.

HELPER: Assistance channel for non-emergency help. Compass tracking enabled.

TAXI: Transportation requests. Compass guides staff to the requesting player.

918: Emergency response channel with compass guidance.

900: Emergency response channel with compass guidance.

920: Emergency response channel with compass guidance.

910: Emergency response channel with compass guidance.

Commands

Player Commands
/sos <reason> - Submit a general help request
/911 <reason> - Submit an emergency request
/qrr - Submit a quick response request
/medic <reason> - Submit a medical assistance request
/912 <reason> - Submit an emergency 912 request
/190 <reason> - Submit a police request
/mecanic <reason> - Submit a mechanical assistance request
/support <reason> - Submit a support request
/helper <reason> - Submit a helper assistance request
/taxi - Submit a taxi request
/918 <reason> - Submit an emergency 918 request
/900 <reason> - Submit an emergency 900 request
/920 <reason> - Submit an emergency 920 request
/910 <reason> - Submit an emergency 910 request

Staff Commands
/staff - Opens SOS tickets menu
/911gui - Opens emergency 911 tickets menu
/qrrmenu - Opens QRR tickets menu
/medicgui - Opens medical tickets menu
/912gui - Opens emergency 912 tickets menu
/190gui - Opens police tickets menu
/mecanicgui - Opens mechanic tickets menu
/supportgui - Opens support tickets menu
/helpergui - Opens helper tickets menu
/taxigui - Opens taxi tickets menu
/918gui - Opens emergency 918 tickets menu
/900gui - Opens emergency 900 tickets menu
/920gui - Opens emergency 920 tickets menu
/910gui - Opens emergency 910 tickets menu
/staffhelp reload - Reloads plugin configuration

Permissions

Staff Permissions
staffhelp.staff - Master staff permission granting access to all staff functionality
staffhelp.staff.menu - Allows access to all GUI menus
staffhelp.staff.reload - Allows use of /staffhelp reload
staffhelp.staff.sos - Allows viewing SOS tickets
staffhelp.staff.911 - Allows viewing 911 tickets
staffhelp.staff.qrr - Allows viewing QRR tickets
staffhelp.staff.medic - Allows viewing medical tickets
staffhelp.staff.912 - Allows viewing 912 tickets
staffhelp.staff.190 - Allows viewing 190 tickets
staffhelp.staff.mecanic - Allows viewing mechanic tickets
staffhelp.staff.support - Allows viewing support tickets
staffhelp.staff.helper - Allows viewing helper tickets
staffhelp.staff.taxi - Allows viewing taxi tickets
staffhelp.staff.918 - Allows viewing 918 tickets
staffhelp.staff.900 - Allows viewing 900 tickets
staffhelp.staff.920 - Allows viewing 920 tickets
staffhelp.staff.910 - Allows viewing 910 tickets

Player Permissions
staffhelp.player - Master player permission granting access to all player commands
staffhelp.player.sos - Allows use of /sos
staffhelp.player.911 - Allows use of /911
staffhelp.player.qrr - Allows use of /qrr
staffhelp.player.medic - Allows use of /medic
staffhelp.player.912 - Allows use of /912
staffhelp.player.190 - Allows use of /190
staffhelp.player.mecanic - Allows use of /mecanic
staffhelp.player.support - Allows use of /support
staffhelp.player.helper - Allows use of /helper
staffhelp.player.taxi - Allows use of /taxi
staffhelp.player.918 - Allows use of /918
staffhelp.player.900 - Allows use of /900
staffhelp.player.920 - Allows use of /920
staffhelp.player.910 - Allows use of /910

Configuration

The config.yml file controls all plugin messages and GUI titles. All messages support color codes using the ampersand symbol.

Message Format
messages:
prefix: "&8[&bStaffHelp&8]"
no-permission: "&cYou don't have permission!"

Request type messages follow this pattern:
[type]-sent: "&aRequest sent!"
[type]-gui-title: "&c&lMENU TITLE"

Each request type can have custom compass name and lore configured:
[type].compass-name: "&cCompass - %player%"
[type].compass-lore: "&7Follow this compass to %player%"

Installation

1. Download the StaffHelp.jar file
   
   
2. Place the file in your server's plugins directory
   
   
3. Restart your server or execute /reload confirm
   
   
4. Optional: Edit plugins/StaffHelp/config.yml to customize messages
   
   
5. Configure permissions using your preferred permission management plugin
   

Technical Details

Data Storage
All requests are stored in plugins/StaffHelp/data.dat using YAML format. The file is automatically saved when requests are created or resolved.

Compass Tracking
Compasses are given to staff when accepting certain request types. The compass target updates in real-time for QRR requests, allowing staff to track moving players. Compasses are automatically removed when the staff member reaches the target location or when the target player goes offline.

Asynchronous Operations
All file operations and staff alerts run asynchronously to prevent server lag. GUI creation and inventory operations run on the main thread for compatibility.

World Support
The plugin caches world references for performance. When a world is unloaded, it is removed from cache automatically.

Performance Considerations

• World cache clears every 5 minutes to prevent memory issues
  
  
• Compass trackers update every 2 seconds for non-QRR requests
  
  
• QRR compasses update on player movement for real-time tracking
  
  
• All configurable message strings support color codes
  

Troubleshooting

Compass not updating
Ensure the target player is online. Compasses for QRR requests only update when the target is online.

Commands not working
Verify the player has the appropriate permission node. Staff commands require staffhelp.staff.menu permission.

Messages not displaying colors
Colors use ampersand codes in config.yml. The plugin converts these to section symbols automatically.

Data not saving
Ensure the plugins/StaffHelp/ directory exists and is writable. Check console for any file IO errors.

Support

For bug reports, feature requests, or support inquiries, please contact the developer through the official distribution channel. Include the server version, plugin version, and any relevant error messages from console when reporting issues.

Version History

1.5

• Added 12 new request types: MEDIC, 912, 190, MECANIC, SUPPORT, HELPER, TAXI, 918, 900, 920, 910
  
  
• Added corresponding GUI menus for each new request type
  
  
• Added permission nodes for all new commands
  
  
• Updated configuration file with messages for all new request types
  

1.4

• Initial release with SOS, 911, and QRR request types
  
  
• Basic compass tracking functionality
  
  
• GUI menu system
  
  
• Asynchronous operations
  

Thanks for downloading!