Discord vPerms!
A guide to install Discord vPerms (Vehicle allowlist)! for FiveM
๐ Table of Contents
- ๐ฏ Overview
- ๐ Purchase Information
- ๐บ Video Showcase
- ๐ฆ Installation Process
- โ ๏ธ Important Pre-Installation Notes
- ๐ง System Requirements & Compatibility
- โ๏ธ Configuration Setup
- ๐ฎ How It Works
- ๐ Integration & Compatibility
- ๐ ๏ธ Troubleshooting
- ๐ก Best Practices
- ๐บ Installation Tutorial
- ๐ Support
๐ฏ 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
- โ 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
๐ Purchase Information
Get Discord vPerms! for FiveM:
Base: Purchase on Nights Software Store
๐บ Video Showcase
Watch the video showcase:
๐ฆ Installation Process
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
- 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
Add the resource to your server.cfg
:
ensure night_discord_vperms
Step 4: Configure Settings
- Open
/config/config.lua
in your preferred editor - Configure Discord roles and vehicle permissions
- Test the resource functionality
โ ๏ธ Important Pre-Installation Notes
Critical Installation Order: Always follow this exact sequence to avoid parsing errors in the F8 console:
- Download ZIP Package from CFX Portal
- Unpack in a folder on your local machine
- Set your File Transfer Protocol (FTP) type to binary
- Drag files from local machine to server resources folder
- Add to server.cfg (ensure script)
- Boot up the server
Support Policy: Follow this guide step by step. If youโre stuck, ask for support in our Discord and provide the specific step name. Do not skip steps.
๐ง System Requirements & Compatibility
Framework Compatibility
- โ Standalone: Works independently without any framework
OneSync Compatibility
- โ OneSync Legacy: Fully tested and compatible
- โ OneSync Infinity: Fully tested and compatible
Dependencies
- Included: Discord API resource (included in this package)
Note: vPerms is designed as a standalone resource that works with any FiveM server configuration and includes the required Discord API.
โ๏ธ Configuration Setup
Required Tools
Visual Studio Code: We recommend downloading VS Code for editing Lua files.
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
- 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
Discord Configuration: Set up Discord roles and vehicle permissions with drag & drop simplicity.
๐ฎ How It Works
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
- 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
- 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
- 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
Framework Support
- Standalone - Works independently without framework dependencies
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
- 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
- Performance Optimized - Efficient permission checking and validation
- Easy Integration - Simple setup and configuration
Vehicle Security: vPerms enhances vehicle security with Discord role-based access control.
๐ ๏ธ Troubleshooting
Common Issues
Being Kicked from Vehicle
- Check if you have the required Discord roles
- Verify Discord API is working (check config and server console)
- Ensure vehicle model names are correctly defined
Discord API Issues
- Check Discord API configuration in config.lua
- Verify Discord bot permissions and webhook settings
- Ensure Discord API resource is properly started
Vehicle Model Names
- Turn on debug in config.lua to see actual vehicle names
- Check F8 console logs for vehicle model names
- Fix vehicles.meta file if vehicle names are incorrect
Configuration Errors
- Check the config.lua file for syntax errors
- Verify Discord role and vehicle configurations
- Test with default settings first
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
Debug Mode: Use debug mode to identify vehicle model names and troubleshoot permission issues.
๐ก Best Practices
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
- 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
- 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
- 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
Watch the installation tutorial:
Visual Guide: Follow the video tutorial for step-by-step installation guidance.
๐ 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: