Discord Allowlist
Drag, drop and configure! Utilized by our free Discord API. This script allows you to define member roles which will be able and unable to join your server. Easy installation and configuration.
Overview
Section titled “Overview”Discord Allowlist is a streamlined access control system that integrates with your Discord server to manage who can join your FiveM server. By utilizing Discord roles, you can easily define which members are allowed or blocked from accessing your server, providing a simple yet powerful way to control server access.
Key Features
Section titled “Key Features”- Drag, Drop & Configure - Simple installation and setup process
- Discord API Integration - Utilizes our free Discord API
- Role-Based Access Control - Define member roles for allowlist/blocklist
- Easy Configuration - Simple setup and management
- Flexible Permissions - Allow or block specific Discord roles
- Seamless Integration - Works directly with Discord server roles
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 Allowlist” 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_discordallowlistfolder 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_discordallowlistStep 5: Configuration Setup
Section titled “Step 5: Configuration Setup”-
Navigate to Config File
- Open
night_discordallowlist/config/config.lua - Review all configuration options
- Open
-
Configure Role Permissions
- Set the roles you desire allowlisted or blacklisted
- Configure Discord role integration
- Adjust access control settings
How It Works
Section titled “How It Works”Access Control System
Section titled “Access Control System”- Role-Based Permissions: Use Discord roles to control server access
- Allowlist/Blacklist: Define which roles can or cannot join
- Real-Time Verification: Check Discord roles when players connect
- Automatic Enforcement: Block or allow access based on role status
Discord Integration
Section titled “Discord Integration”- Free Discord API: Utilizes our included Discord API
- Seamless Role Checking: Verify Discord roles automatically
- Easy Management: Control access through Discord role management
- Flexible Configuration: Allow or block specific role types
Server Protection
Section titled “Server Protection”- Access Control: Prevent unauthorized players from joining
- Role Verification: Ensure only approved Discord members can access
- Easy Administration: Manage access through Discord role system
- Reliable Security: Consistent role-based access enforcement
Integration & Compatibility
Section titled “Integration & Compatibility”Framework Integration
Section titled “Framework Integration”- Discord API Integration: Seamless role-based access control
- Universal Compatibility: Works with all FiveM server setups
- Role-Based Security: Integrates with Discord server roles
Server Applications
Section titled “Server Applications”- Private Communities: Control access to exclusive servers
- Whitelist Servers: Ensure only approved members can join
- Role-Based Access: Different access levels for different roles
- Security-Focused Servers: Enhanced protection against unauthorized access
Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”Discord API Not Working
Section titled “Discord API Not Working”Role Permissions Not Working
Section titled “Role Permissions Not Working”Players Being Blocked
Section titled “Players Being Blocked”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 |
| “Role verification failed” | Check Discord bot permissions and roles |
| “Access denied” | Verify role configuration in allowlist/blacklist |
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 permissions with different Discord roles
- Configure clear allowlist/blacklist rules for your server
- Regularly review role assignments for security
Server Integration
Section titled “Server Integration”- Coordinate with Discord server for role management
- Set up clear role hierarchy for access control
- Test access permissions with different user types
- Monitor access logs for security and troubleshooting
Security Management
Section titled “Security Management”- Use specific roles for different access levels
- Regularly update role permissions as needed
- Monitor unauthorized access attempts
- Keep Discord API credentials secure
Support
Section titled “Support”Getting Help
Section titled “Getting Help”If you’re having trouble with Discord Allowlist:
- 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