Discord Playerlist
Display your players by Discord roles and customize buttons per role!
Overview
Section titled “Overview”Discord Playerlist is a dynamic player management system that integrates with your Discord server to display players organized by their Discord roles. With customizable buttons for each role, you can create a comprehensive and organized player list that enhances your server’s community management.
Key Features
Section titled “Key Features”- Discord Role Integration - Display players organized by Discord roles
- Customizable Buttons - Configure buttons per role for different actions
- Real-Time Updates - Live player list updates based on Discord roles
- Easy Configuration - Simple setup and management
- Role-Based Organization - Clear player categorization by Discord roles
- Custom Title Image - Replace playerlist title image with your own link
Important Pre-Installation Notes
Section titled “Important Pre-Installation Notes”System Requirements & Compatibility
Section titled “System Requirements & Compatibility”Dependencies
Section titled “Dependencies”- Discord API - Required for Discord integration
- Universal - Works with any FiveM server setup
- Role-Based - Integrates with Discord server roles
Installation Process
Section titled “Installation Process”Step 1: Install Discord API (Required)
Section titled “Step 1: Install Discord API (Required)”- Install night_discordapi first
- Download and install the Discord API resource
- Configure the Discord API resource completely
- Ensure it’s working properly before proceeding
Step 2: Download the Resource
Section titled “Step 2: Download the Resource”- Access CFX Portal
- Go to CFX Portal Assets
- Find “Discord Playerlist” in your granted assets
- Download the ZIP package
Step 3: Extract and Transfer
Section titled “Step 3: Extract and Transfer”-
Extract the ZIP file
- Unpack the downloaded ZIP package to a local folder
- Ensure all files are properly extracted
-
Transfer to Server
- Set your FTP client to binary transfer mode
- Upload the
night_playerlistfolder to your server’sresourcesdirectory - Maintain the original folder structure
Step 4: Server Configuration
Section titled “Step 4: Server Configuration”Add the following line to your server.cfg file:
ensure night_playerlistStep 5: Configuration Setup
Section titled “Step 5: Configuration Setup”-
Navigate to Config File
- Open
night_playerlist/config/config.lua - Review all configuration options
- Open
-
Configure Playerlist Settings
- Set up Discord role integration
- Configure customizable buttons per role
- Insert a link to replace your playerlist title image
- Adjust role-based organization settings
How It Works
Section titled “How It Works”Player Organization System
Section titled “Player Organization System”- Discord Role Integration: Display players organized by their Discord roles
- Real-Time Updates: Live updates as players join, leave, or change roles
- Role-Based Categorization: Clear organization of players by Discord roles
- Dynamic Display: Automatic updates based on Discord role changes
Customizable Interface
Section titled “Customizable Interface”- Role-Based Buttons: Configure different buttons for each Discord role
- Custom Title Image: Replace the default title image with your own link
- Flexible Layout: Adapt the playerlist to match your server’s theme
- Easy Management: Simple configuration for different role types
Discord Integration
Section titled “Discord Integration”- Seamless Role Checking: Verify Discord roles automatically
- Permission-Based Display: Show players based on their Discord roles
- Easy Administration: Manage player display through Discord role system
- Consistent Updates: Real-time synchronization with Discord roles
Integration & Compatibility
Section titled “Integration & Compatibility”Framework Integration
Section titled “Framework Integration”- Discord API Integration: Seamless role-based player organization
- Universal Compatibility: Works with all FiveM server setups
- Role-Based Management: Integrates with Discord server roles
Server Applications
Section titled “Server Applications”- Community Servers: Organize players by membership levels
- Roleplay Servers: Display players by their roleplay roles
- Gaming Communities: Categorize players by gaming roles
- Administrative Teams: Organize staff and admin players
Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”Discord API Not Working
Section titled “Discord API Not Working”Playerlist Not Displaying
Section titled “Playerlist Not Displaying”Buttons Not Working
Section titled “Buttons Not Working”Error Messages
Section titled “Error Messages”| Error | Solution |
|---|---|
| “Resource not found” | Check resource folder name and ensure line |
| “Discord API not found” | Install and configure night_discordapi first |
| “Playerlist not displaying” | Check Discord role and configuration settings |
| “Buttons not working” | Verify button configuration per role |
Best Practices
Section titled “Best Practices”Configuration Best Practices
Section titled “Configuration Best Practices”- Install Discord API first and ensure it’s working properly
- Test role-based display with different Discord roles
- Configure clear button functions for each role type
- Use custom title images that match your server’s theme
Server Integration
Section titled “Server Integration”- Coordinate with Discord server for role management
- Set up clear role hierarchy for player organization
- Test playerlist display with different user types
- Monitor role changes for consistent updates
Player Management
Section titled “Player Management”- Use specific roles for different player categories
- Regularly update role assignments as needed
- Monitor playerlist functionality for issues
- Keep Discord API credentials secure
Support
Section titled “Support”Getting Help
Section titled “Getting Help”If you’re having trouble with Discord Playerlist:
- Review this documentation thoroughly
- Check server console for error messages
- Join our Discord for community support
Community Support
Section titled “Community Support”Join our Discord community for:
- Technical support
- Configuration help
- Best practices sharing
- Community discussions