zPlayerListGui icon

zPlayerListGui -----

Lightweight Player List GUI with Discord Integration

Download Now
296.5 KB .jar


zPlayerListGui
Lightweight Player List GUI with Discord Integration​

A modern, feature-rich player list GUI plugin for Minecraft servers with Discord integration and extensive customization options.​


upload_2025-6-7_16-8-41.png
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Plugin Information

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

✨ Features

Dynamic GUI
  • Animated Borders: Dynamic glass pane borders with color cycling
  • Sound Effects: Enhanced audio feedback with opening sequences
  • Auto-Sizing: GUI automatically adjusts based on player count
  • Custom Styling: Fully configurable colors and materials

Player Information Display
  • Player Skulls: Real player heads with detailed information
  • Rank/Prefix: Integration with Vault permissions
  • Player Stats: Level, health, hunger, balance, world
  • Real-time Data: Live player information updates

Advanced Sound System
  • Opening Effects: Multi-layered sound sequences when GUI opens
  • Border Animations: Subtle chimes during border transitions
  • Click Feedback: Satisfying click sounds for interactions
  • Configurable: All sounds can be customized or disabled

Discord Integration
  • Webhook Integration: Lightweight Discord notifications using webhooks
  • Player Notifications: Track GUI access and interactions
  • Server Events: Monitor player activities
  • Rich Embeds: Formatted Discord messages with timestamps

⚙️ Configuration System
  • Hot Reload: Change settings without restart
  • Chat Configuration: In-game GUI name changes
  • Color Customization: Hex color support
  • Advanced Settings: Border materials, update intervals

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Installation
  1. Download the zPlayerListGui-2.0-SNAPSHOT.jar file
  2. Place it in your server's plugins folder
  3. Install dependencies:
    • Vault (optional but recommended for economy/permissions)
  4. Restart your server
  5. Configure the plugin in plugins/zPlayerListGui/config.yml

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

️ Dependencies
Required
  • Spigot/Paper: 1.16 or higher

Optional
  • Vault: For economy and permission integration
  • DiscordSRV: For enhanced Discord features

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Commands
Command Description Permission
/list Opens the player list GUI playerlist.use
/playerlist help Shows help menu playerlist.admin
/playerlist reload Reloads configuration playerlist.admin
/playerlist config Changes GUI name via chat playerlist.admin
/playerlist discord Discord integration info playerlist.admin


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Permissions
Permission Description Default
playerlist.admin Access to admin commands OP only
playerlist.use Can open player list GUI All players


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

⚙️ Configuration
Colors
Code (Text):

colors:
  primary: '<##8555b5>'      # Main purple theme
  secondary: '<##9788a6>'    # Secondary gray-purple
  name: '<##8555b5>'         # Player name color
  invalid: '&4'              # Error message color
  icon: '<##8555b5>'         # Icon color
 
GUI Settings
Code (Text):

gui:
  name: '&5Online Players'
  icon: '●'
  lines:
    line1: 'Rank: <##8555b5>%player_prefix%'
    line2: 'Level: <##8555b5>%player_level%'
  # ... more lines
 
Sound Effects
Code (Text):

sounds:
  enabled: true
  gui-open: 'BLOCK_CHEST_OPEN'
  click: 'UI_BUTTON_CLICK'
 
Discord Integration
Code (Text):

discord:
  enabled: false
  bot-token: ''
  webhook-url: ''
 
Advanced Features
Code (Text):

advanced:
  max-rows: 6
  border-enabled: true
  border-material: 'PURPLE_STAINED_GLASS_PANE'
  update-interval: 20
 
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Discord Setup
  1. Go to your Discord server settings
  2. Navigate to Integrations > Webhooks
  3. Click "New Webhook" and configure:
    • Name: zPlayerListGui
    • Channel: Choose where notifications should appear
    • Copy the webhook URL
  4. Paste the webhook URL in config.yml under discord.webhook-url
  5. Set discord.enabled: true in config

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Customization
Colors
  • Plugin supports both legacy (&c) and hex (<##FF0000>) color codes

Border Animation
  • 4 different glass pane materials cycle automatically
  • Configurable animation speed and materials
  • Sound effects synchronized with animations

Player Information
  • Fully customizable information lines
  • Vault integration for ranks and economy
  • Real-time health, hunger, and level display

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Technical Details
Architecture
  • Main Class: ZPlayerListGui - Core plugin management
  • GUI System: Dynamic inventory creation with animation
  • Config Manager: Hot-reload configuration system
  • Discord Integration: JDA-based bot with async operations
  • Animation Manager: Border effects and sound coordination

Performance
  • Lightweight design with minimal server impact
  • Async Discord operations to prevent lag
  • Efficient GUI updates only when needed
  • Memory-conscious animation system

Compatibility
  • Works with all major server software (Spigot, Paper, etc.)
  • Compatible with popular permission plugins via Vault
  • Supports economy plugins through Vault API
  • Cross-version compatible from 1.16+

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Troubleshooting
Common Issues
  • GUI not opening:
    • Check permissions: playerlist.use
    • Verify no conflicting plugins
    [*]Discord not working:
    • Verify bot token is correct
    • Check bot permissions in Discord server
    • Enable Discord integration in config
    [*]Sounds not playing:
    • Ensure client has sounds enabled
    • Check if sound names are valid for your MC version
    • Verify sounds.enabled: true in config
    [*]Vault integration issues:
    • Install Vault plugin
    • Ensure permission/economy plugin is Vault-compatible
    • Check server logs for Vault-related errors


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Migration from Skript

  • Performance: Native Java performance vs interpreted Skript
  • Features: Advanced animations, Discord integration, enhanced sounds
  • Reliability: Proper error handling and edge case management
  • Maintainability: Clean, documented codebase
  • Extensibility: Easy to add new features and customizations
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Changelog
v2.0 (Current)

  • Complete rewrite in Java from original Skript
  • Added animated border system with multiple materials
  • Enhanced sound system with opening sequences
  • Discord integration with JDA 5.0
  • Configurable GUI sizing and materials
  • Vault integration for permissions and economy
  • Hot-reload configuration system
  • Comprehensive error handling
  • Performance optimizations
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Support

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

License
This plugin is created by GamingHuzai for the Minecraft community. Licensed under MIT License.

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Placeholders
Placeholder Description
%player_name% Player's display name
%player_prefix% Player's prefix from permissions
%player_level% Player's experience level
%player_health% Player's current health
%player_hunger% Player's hunger level
%vault_eco_balance% Player's economy balance
%player_world% Player's current world


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Made with ❤️ by GamingHuzai
Built with ❤️ using Maven • Java 8+ • Spigot API • Discord JDA​
View on SpigotMC
Resource Information
Author:
----------
Total Downloads: 11
First Release: Jun 7, 2025
Last Update: Jun 7, 2025
Category: ---------------
All-Time Rating:
0 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings