Discord Vehicle Permissions
A guide to install Discord vPerms (Vehicle allowlist)! for FiveM
Overview
Section titled “Overview”This script allows you to restrict vehicle access by Discord roles. A Discord role will be required to drive the specified vehicle(s) in the configuration. It is possible to set up lists of vehicles per Discord role(s). Drag, drop and configure! Utilized by our free Discord API.
Key Features
Section titled “Key Features”- Discord Role Integration - Restrict vehicle access by Discord roles
- Vehicle Allowlist System - Set up lists of vehicles per Discord role(s)
- Free Discord API - Utilized by our included Discord API resource
- Drag & Drop Setup - Simple configuration and deployment
- Role-Based Access - Require specific Discord roles for vehicle access
- Vehicle Lists - Configure multiple vehicles per role
- Standalone - Works independently without framework dependencies
- Universal Compatibility - Works with any FiveM server
Installation Process
Section titled “Installation Process”Step 1: Download Resource
Section titled “Step 1: Download Resource”Download this resource via CFX Portal Assets after purchasing. It can take a few minutes for the resource to appear in the CFX Portal after purchase.
Step 2: Install Resource
Section titled “Step 2: Install Resource”- Extract the ZIP package to your local machine
- Transfer files using binary FTP mode to your server’s resources folder
- Ensure the folder is named
night_discord_vperms(do not rename)
Step 3: Server Configuration
Section titled “Step 3: Server Configuration”Add the resource to your server.cfg:
ensure night_discord_vpermsStep 4: Configure Settings
Section titled “Step 4: Configure Settings”- Open
/config/config.luain your preferred editor - Configure Discord roles and vehicle permissions
- Test the resource functionality
Important Pre-Installation Notes
Section titled “Important Pre-Installation Notes”System Requirements & Compatibility
Section titled “System Requirements & Compatibility”Framework Compatibility
Section titled “Framework Compatibility”- Standalone: Works independently without any framework
OneSync Compatibility
Section titled “OneSync Compatibility”- OneSync Legacy: Fully tested and compatible
- OneSync Infinity: Fully tested and compatible
Dependencies
Section titled “Dependencies”- Included: Discord API resource (included in this package)
Configuration Setup
Section titled “Configuration Setup”Required Tools
Section titled “Required Tools”Configuration Files
Section titled “Configuration Files”| File | Purpose |
|---|---|
night_discord_vperms/config/config.lua |
Main configuration and Discord settings |
night_discord_vperms/client/c_functions.lua |
Client-side functions |
night_discord_vperms/server/s_functions.lua |
Server-side functions |
Configuration Process
Section titled “Configuration Process”- Open VS Code and navigate to the config files
- Read thoroughly - each line has explanatory comments
- Configure Discord roles - set up role-based vehicle permissions
- Configure vehicle lists - assign vehicles to specific Discord roles
- Test frequently - use F8 console for error checking
How It Works
Section titled “How It Works”Permission System
Section titled “Permission System”- Discord Role Verification - Check player’s Discord roles for vehicle access
- Vehicle Allowlist - Configure which vehicles each role can access
- Real-Time Validation - Verify permissions when players enter vehicles
- Access Control - Restrict vehicle access based on Discord roles
Vehicle Management
Section titled “Vehicle Management”- Role-Based Lists - Set up lists of vehicles per Discord role(s)
- Multiple Roles - Support for multiple Discord roles per vehicle
- Vehicle Categories - Organize vehicles by role requirements
- Permission Hierarchy - Manage different access levels
Configuration Options
Section titled “Configuration Options”- Discord Integration - Configure Discord API settings and webhooks
- Role Assignment - Assign Discord roles to vehicle access
- Vehicle Lists - Create lists of vehicles for each role
- Access Control - Set up permission requirements and restrictions
- Debug Settings - Enable debugging for troubleshooting
Discord API Integration
Section titled “Discord API Integration”- Free Discord API - Utilized by our included Discord API resource
- Role Verification - Real-time Discord role checking
- Webhook Integration - Discord notifications and logging
- API Management - Handle Discord API connections and authentication
Integration & Compatibility
Section titled “Integration & Compatibility”Framework Support
Section titled “Framework Support”- Standalone - Works independently without framework dependencies
Discord Integration
Section titled “Discord Integration”- Role-Based Access - Restrict vehicle access by Discord roles
- Real-Time Verification - Check Discord roles when accessing vehicles
- Webhook Notifications - Discord notifications for vehicle access
- API Management - Handle Discord API connections and authentication
Script Integration
Section titled “Script Integration”- Vehicle Management - Integrate with existing vehicle systems
- Permission Systems - Connect with server permission management
- Access Control - Enhance vehicle security and access control
- Custom Scripts - Perfect foundation for building role-based systems
Server Integration
Section titled “Server Integration”- Performance Optimized - Efficient permission checking and validation
- Easy Integration - Simple setup and configuration
Troubleshooting
Section titled “Troubleshooting”Common Issues
Section titled “Common Issues”Debugging Tips
Section titled “Debugging Tips”- Enable Debug Mode - Turn on debug in config.lua for detailed logging
- Check F8 Console - Look for vehicle model names and error messages
- Verify Discord Roles - Ensure roles are correctly assigned
- Test Vehicle Access - Try accessing vehicles with proper roles
- Check File Permissions - Ensure all files are accessible
Best Practices
Section titled “Best Practices”Discord Role Management
Section titled “Discord Role Management”- Clear Role Structure - Design logical Discord role hierarchy
- Role Permissions - Assign appropriate vehicle access to roles
- Role Verification - Regularly verify Discord role assignments
- Access Control - Implement proper role-based access control
Vehicle Configuration
Section titled “Vehicle Configuration”- Vehicle Lists - Organize vehicles by role requirements
- Model Names - Use correct vehicle model names in configuration
- Testing - Thoroughly test vehicle access with different roles
- Documentation - Document vehicle-role assignments
Discord Integration
Section titled “Discord Integration”- API Configuration - Properly configure Discord API settings
- Webhook Setup - Set up Discord webhooks for notifications
- Bot Permissions - Ensure Discord bot has necessary permissions
- API Monitoring - Monitor Discord API connection status
Security Best Practices
Section titled “Security Best Practices”- Role Verification - Implement secure Discord role checking
- Access Logging - Log vehicle access attempts and permissions
- Error Handling - Handle Discord API failures gracefully
- User Communication - Provide clear feedback for access denials
Installation Tutorial
Section titled “Installation Tutorial”Watch the installation tutorial:
Support
Section titled “Support”Read through the instructions again if you have not managed to install the resource. Can’t get it to work still? Create a ticket through our dedicated support system in Discord: