Discord API Resource

Discord API

A comprehensive FiveM resource for integrating Discord functionality into your server. This resource provides easy access to Discord user data, guild membership, roles, and more through a simple API.

Table of contents

📋 Overview
🎥 Installation Tutorial
🛒 Purchase & Download
1. Purchase Location
2. Download Method
⚙️ Installation Process
🔧 Configuration
🤖 Creating Your Own Discord Bot
📚 Exports
💡 Usage Examples
🔗 Integration with Other Resources
🚨 Troubleshooting
📊 Performance Optimization
1. Best Practices
2. Monitoring
📞 Support
1. Getting Help
2. Useful Links

📋 Overview

The Discord API resource provides seamless integration between your FiveM server and Discord, enabling:

Role-based permissions across all connected resources
Real-time player synchronization with Discord roles
Automatic player management based on Discord membership
Cross-platform communication between Discord and FiveM
Discord User Management: Check if users are members of specific Discord servers
Role Verification: Verify user roles across multiple Discord servers
User Data Retrieval: Get Discord user information, avatars, and member details
Guild Information: Retrieve Discord server/guild information
Caching System: Built-in caching for improved performance
Rate Limiting: Automatic Discord API rate limit handling
Multi-Guild Support: Support for multiple Discord servers
Custom Role Mapping: Map Discord role IDs to custom names

Prerequisites: You’ll need a Discord bot token and basic knowledge of Discord server management.

🎥 Installation Tutorial

Video Guide - Watch comprehensive installation tutorial(s):

Discord API Installation Tutorial How to Create a Discord Bot - Quick Tutorial

🛒 Purchase & Download

Purchase Location

Tebex Store: Discord API Package

Download Method

Download via CFX Portal after purchase.

Important: It may take a few minutes for the resource to appear in the CFX Portal after purchase.

⚙️ Installation Process

Step 1: File Transfer

Critical: Always follow this exact order to avoid parsing errors:

Download the ZIP package
Extract to a local folder
Set FTP transfer mode to binary
Upload files to your server’s resources folder
Add to server.cfg
Restart your server

Step 2: Server Configuration

Add the resource to your server.cfg somewhere ON TOP as one of the first starting resources:

ensure night_discordapi

Pro Tip: Place this line before any other resources that depend on Discord API.

Step 3: Configuration Setup

Configure /config/config.lua (see configuration section below).

🔧 Configuration

Note: This resource requires a Discord bot to function. You must create your own Discord bot application. How to do this is covered in the next step.

Basic Configuration

Config = {
    -- Discord Bot Token
    Discord_Bot_Token = "",
    
    -- Discord Guild/Server Configuration
    Discord_Guild_Names = {
        ["YOUR_GUILD_ID"] = "Your Guild Name",
        ["ANOTHER_GUILD_ID"] = "Another Guild Name",
    },
    
    -- Discord Role Mapping
    Discord_Role_Names = {
        ["ROLE_ID"] = "Role_Name",
        ["ANOTHER_ROLE_ID"] = "Another_Role",
    },
    
    -- Logging Level (0 = INFO/ERROR/WARN only, 1+ = includes DEBUG)
    Discord_API_Log_Level = 1,
}

Configuration Details

Discord_Bot_Token: Your Discord bot token
Discord_Guild_Names: Map Discord server IDs to readable names
Discord_Role_Names: Map Discord role IDs to custom role names
Discord_API_Log_Level: Control logging verbosity

Discord Bot Token

You must provide your own Discord bot token. Follow the tutorial above to create your bot and obtain the token:

Discord_Bot_Token = "YOUR_BOT_TOKEN_HERE"

Important: Keep your bot token secure and never share it publicly. The token provides access to your Discord bot.

🤖 Creating Your Own Discord Bot

📺 How to Create a Discord Bot - Quick Tutorial

Step 1: Create a New Application

Go to Discord Developer Portal
Click “New Application”
Enter a name for your application (e.g., “My FiveM Server Bot”)
Click “Create”

Step 2: Set Up the Bot

In your application’s settings, select the “Bot” tab
Click “Add Bot” and confirm by clicking “Yes, do it!”
Customize your bot’s username and profile picture as desired

Step 3: Retrieve the Bot Token

Under the “Bot” tab, click the “Reset Token” button to generate a new token
Copy the token and store it securely - this token is essential for your bot’s functionality

Step 4: Set Up OAuth2 for Bot Permissions

Navigate to the “OAuth2” tab in your application’s settings
Under “Scopes”, select “bot”
In the “Bot Permissions” section, choose the permissions your bot requires:
- Read Messages/View Channels
- Any other functionalities to obtain member (role) information
Copy the generated URL

Step 5: Invite the Bot to Your Server

Paste the copied URL into your browser
Select the server you want to add the bot to and click “Authorize”
Complete any CAPTCHA verification if prompted

Important: The bot does NOT have to be online.

📚 Exports

The Discord API provides comprehensive exports for checking guild membership, user data, roles, and guild information.

Guild Membership Functions

`IsUserPartOfThisGuild(src, force, guildName)`

Check if a player is a member of a specific Discord server.

Parameters:

src (string): Player source ID
force (boolean): Force refresh cache (required)
guildName (string): Name of the Discord server (as defined in config) (required)

Returns: boolean - true if user is a member, false if not, nil on error

Example:

local isMember = exports['night_discordapi']:IsUserPartOfThisGuild(source, false, "Your Guild Name")
if isMember then
    print("Player is a member of the Discord server!")
end

`IsUserPartOfAnyOfTheseGuilds(src, force, guildNames)`

Check if a player is a member of any of the specified Discord servers.

Parameters:

src (string): Player source ID
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user is a member of any server, false if not, nil on error

Example:

local guildNames = {"Guild 1", "Guild 2", "Guild 3"}
local isMember = exports['night_discordapi']:IsUserPartOfAnyOfTheseGuilds(source, false, guildNames)
if isMember then
    print("Player is a member of at least one Discord server!")
end

`IsUserPartOfAllOfTheseGuilds(src, force, guildNames)`

Check if a player is a member of all specified Discord servers.

Parameters:

src (string): Player source ID
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user is a member of all servers, false if not, nil on error

Example:

local guildNames = {"Guild 1", "Guild 2"}
local isMember = exports['night_discordapi']:IsUserPartOfAllOfTheseGuilds(source, false, guildNames)
if isMember then
    print("Player is a member of all Discord servers!")
end

User Data Functions

`GetDiscordUser(src, force)`

Get Discord user information for a player.

Parameters:

src (string): Player source ID
force (boolean): Force refresh cache (optional)

Returns: table - User data containing id, name, avatar, or nil on error

Example:

local userData = exports['night_discordapi']:GetDiscordUser(source, false)
if userData then
    print("Discord ID: " .. userData.id)
    print("Username: " .. userData.name)
    print("Avatar: " .. (userData.avatar or "No avatar"))
end

`GetDiscordMember(src, force, guildNames)`

Get Discord member information for a player in specific servers.

Parameters:

src (string): Player source ID
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: table - Member data containing id, name, nick, avatar, discriminator, roles, or nil on error

Example:

local memberData = exports['night_discordapi']:GetDiscordMember(source, false, {"Your Guild Name"})
if memberData then
    print("Member ID: " .. memberData.id)
    print("Nickname: " .. (memberData.nick or "No nickname"))
    print("Roles: " .. table.concat(memberData.roles, ", "))
end

Role Functions

`GetDiscordMemberRoles(src, force, guildNames)`

Get all Discord roles for a player across specified servers.

Parameters:

src (string): Player source ID
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: table - Array of role names, or nil on error

Example:

local roles = exports['night_discordapi']:GetDiscordMemberRoles(source, false, {"Guild 1", "Guild 2"})
if roles then
    for _, role in ipairs(roles) do
        print("Role: " .. role)
    end
end

This function returns role names filtered through Config.Discord_Role_Names — only roles you have mapped in the config will be returned. If you need the raw Discord role IDs (so your own resource can match by ID against its own mapping table), use GetDiscordMemberRoleIds instead.

`GetDiscordMemberRoleIds(src, force, guildNames)`

Get the raw, unfiltered Discord role IDs for a player across the specified servers. Unlike GetDiscordMemberRoles, this does not filter against Config.Discord_Role_Names — you receive every role ID Discord returns for that member. Useful for downstream resources (e.g. Night Shifts MDT) that maintain their own role-mapping tables and need to match by stable role ID rather than role name.

Parameters:

src (number/string): Player source ID
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names — uses all configured guilds when omitted (optional)

Returns: table — Array of role ID strings (e.g. "123456789012345678"), or nil on error. Empty array when the member is in the guild but holds no roles.

Example:

local roleIds = exports['night_discordapi']:GetDiscordMemberRoleIds(source, false, {"Your Guild"})
if roleIds then
    for _, id in ipairs(roleIds) do
        print("Role ID: " .. id)
    end
end

Results are cached separately from GetDiscordMemberRoles (same TTL/eviction behaviour), so calling both in the same session does not double-spend Discord API requests.

`IsMemberPartOfThisRole(src, roleName, force, guildNames)`

Check if a player has a specific Discord role.

Parameters:

src (string): Player source ID
roleName (string): Name of the role to check
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user has the role, false if not, nil on error

Example:

local hasRole = exports['night_discordapi']:IsMemberPartOfThisRole(source, "Admin", false, {"Your Guild"})
if hasRole then
    print("Player has Admin role!")
end

`IsMemberPartOfAnyOfTheseRoles(src, roleNames, force, guildNames)`

Check if a player has any of the specified Discord roles.

Parameters:

src (string): Player source ID
roleNames (table): Array of role names to check
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user has any of the roles, false if not, nil on error

Example:

local roleNames = {"Admin", "Moderator", "VIP"}
local hasRole = exports['night_discordapi']:IsMemberPartOfAnyOfTheseRoles(source, roleNames, false, {"Your Guild"})
if hasRole then
    print("Player has at least one of the specified roles!")
end

`IsMemberPartOfAllOfTheseRoles(src, roleNames, force, guildNames)`

Check if a player has all of the specified Discord roles.

Parameters:

src (string): Player source ID
roleNames (table): Array of role names to check
force (boolean): Force refresh cache (optional)
guildNames (table): Array of Discord server names (optional)

Returns: boolean - true if user has all roles, false if not, nil on error

Example:

local roleNames = {"Admin", "Moderator"}
local hasAllRoles = exports['night_discordapi']:IsMemberPartOfAllOfTheseRoles(source, roleNames, false, {"Your Guild"})
if hasAllRoles then
    print("Player has all specified roles!")
end

Guild Information Functions

`GetDiscordGuild(guildName, force)`

Get information about a Discord server/guild.

Parameters:

guildName (string): Name of the Discord server (as defined in config)
force (boolean): Force refresh cache (optional)

Returns: table - Guild data containing id, name, icon, ownerid, roles, or nil on error

Example:

local guildData = exports['night_discordapi']:GetDiscordGuild("Your Guild Name", false)
if guildData then
    print("Guild ID: " .. guildData.id)
    print("Guild Name: " .. guildData.name)
    print("Owner ID: " .. guildData.ownerid)
end

Configuration Functions

These read straight from config.lua so other resources can enumerate the mappings this resource knows about — useful for rendering admin dropdowns (“pick a configured role / guild”) without hard-coding lists in every consumer.

`GetConfiguredRoles()`

Returns the configured role-name table from config.lua as { [roleID] = roleName }.

Parameters: None.

Returns: table — { [roleID] = roleName }, or nil if the resource config is invalid.

Example:

local roles = exports['night_discordapi']:GetConfiguredRoles()
if roles then
    for roleId, roleName in pairs(roles) do
        print(roleId, "->", roleName)
    end
end

`GetConfiguredGuilds()`

Returns the configured guild table from config.lua as { [guildID] = guildName }.

Parameters: None.

Returns: table — { [guildID] = guildName }, or nil if the resource config is invalid.

Example:

local guilds = exports['night_discordapi']:GetConfiguredGuilds()
if guilds then
    for guildId, guildName in pairs(guilds) do
        print(guildId, "->", guildName)
    end
end

💡 Usage Examples

Basic Permission System

-- Check if player has admin role
local hasAdmin = exports['night_discordapi']:IsMemberPartOfThisRole(source, "Admin", false, {"Your Guild"})
if hasAdmin then
    -- Give admin permissions
    TriggerClientEvent('chat:addMessage', source, {
        color = {255, 0, 0},
        multiline = true,
        args = {"System", "You have admin permissions!"}
    })
end

Multi-Server Role Check

-- Check if player has role in any of multiple servers
local guildNames = {"Main Server", "Staff Server", "VIP Server"}
local roleNames = {"Admin", "Moderator", "VIP"}
local hasPermission = exports['night_discordapi']:IsMemberPartOfAnyOfTheseRoles(source, roleNames, false, guildNames)

if hasPermission then
    -- Example: Grant access to restricted area
    TriggerClientEvent('restrictedArea:grantAccess', source)
end

User Information Display

-- Get and display user information
local userData = exports['night_discordapi']:GetDiscordUser(source, false)
if userData then
    TriggerClientEvent('chat:addMessage', -1, {
        color = {0, 255, 0},
        multiline = true,
        args = {"Discord", userData.name .. " joined the server!"}
    })
end

Guild Membership Verification

-- Verify player is member of specific guild
local isMember = exports['night_discordapi']:IsUserPartOfThisGuild(source, false, "Whitelisted Guild")
if not isMember then
    DropPlayer(source, "You must be a member of our Discord server to join this server.")
end

Advanced Role System

-- Check multiple roles across multiple servers
local guildNames = {"Police Department", "Fire Department", "EMS"}
local requiredRoles = {"Officer", "Firefighter", "Paramedic"}

local hasRequiredRole = exports['night_discordapi']:IsMemberPartOfAnyOfTheseRoles(source, requiredRoles, false, guildNames)
if hasRequiredRole then
    -- Allow access to emergency services
    TriggerClientEvent('emergency:grantAccess', source)
else
    TriggerClientEvent('chat:addMessage', source, {
        color = {255, 0, 0},
        multiline = true,
        args = {"System", "You need to be verified in our Discord server to access emergency services."}
    })
end

🔗 Integration with Other Resources

The Discord API serves as the foundation for these resources:

Resource	Purpose
Player List	Display players with Discord roles
Player Names	Sync Discord usernames
Garage System	Role-based vehicle access
Vehicle Permissions (vPerms)	Role-based vehicle permissions
Weapon Permissions (wPerms)	Role-based weapon permissions
Discord Spawn	Role-based spawning system
Discord Lockers	Role-based locker access
Discord Allowlist	Discord-based allowlist system
Emergency Response Simulator	A PvE Emergency Response Simulator
Night Shifts MDT	An system managing Emergency Services & Registrations

🚨 Troubleshooting

Common Issues

Bot Not Responding

Verify bot token is correct
Ensure bot is online and has proper permissions
Check bot is invited to your Discord server

Role Permissions Not Working

Confirm role IDs are correct
Verify bot has been given the required permission
Verify the guild names match between the scripts, if applicable.
Verify the role names match between the scripts.

Resource Dependencies

Ensure Discord API loads before dependent resources
Check server.cfg load order

Error Messages

Error	Solution
`Discord API not found`	Check resource name in server.cfg
`Invalid bot token`	Verify token format and validity
`Guild not found`	Confirm guild ID and bot membership

Debug Mode

Enable debug logging by setting Discord_API_Log_Level = 1 in your config to see detailed API request information.

Discord API

📋 Overview

🎥 Installation Tutorial

🛒 Purchase & Download

Purchase Location

Download Method

⚙️ Installation Process

Step 1: File Transfer

Step 2: Server Configuration

Step 3: Configuration Setup

🔧 Configuration

Basic Configuration

Configuration Details

Discord Bot Token

🤖 Creating Your Own Discord Bot

Step 1: Create a New Application

Step 2: Set Up the Bot

Step 3: Retrieve the Bot Token

Step 4: Set Up OAuth2 for Bot Permissions

Step 5: Invite the Bot to Your Server

📚 Exports

Guild Membership Functions

IsUserPartOfThisGuild(src, force, guildName)

IsUserPartOfAnyOfTheseGuilds(src, force, guildNames)

IsUserPartOfAllOfTheseGuilds(src, force, guildNames)

User Data Functions

GetDiscordUser(src, force)

GetDiscordMember(src, force, guildNames)

Role Functions

GetDiscordMemberRoles(src, force, guildNames)

GetDiscordMemberRoleIds(src, force, guildNames)

IsMemberPartOfThisRole(src, roleName, force, guildNames)

IsMemberPartOfAnyOfTheseRoles(src, roleNames, force, guildNames)

IsMemberPartOfAllOfTheseRoles(src, roleNames, force, guildNames)

Guild Information Functions

GetDiscordGuild(guildName, force)

Configuration Functions

GetConfiguredRoles()

GetConfiguredGuilds()

💡 Usage Examples

Basic Permission System

Multi-Server Role Check

User Information Display

Guild Membership Verification

Advanced Role System

🔗 Integration with Other Resources

🚨 Troubleshooting

Common Issues

Bot Not Responding

Role Permissions Not Working

Resource Dependencies

Error Messages

Debug Mode

📊 Performance Optimization

Best Practices

Monitoring

📞 Support

Getting Help

Useful Links

`IsUserPartOfThisGuild(src, force, guildName)`

`IsUserPartOfAnyOfTheseGuilds(src, force, guildNames)`

`IsUserPartOfAllOfTheseGuilds(src, force, guildNames)`

`GetDiscordUser(src, force)`

`GetDiscordMember(src, force, guildNames)`

`GetDiscordMemberRoles(src, force, guildNames)`

`GetDiscordMemberRoleIds(src, force, guildNames)`

`IsMemberPartOfThisRole(src, roleName, force, guildNames)`

`IsMemberPartOfAnyOfTheseRoles(src, roleNames, force, guildNames)`

`IsMemberPartOfAllOfTheseRoles(src, roleNames, force, guildNames)`

`GetDiscordGuild(guildName, force)`

`GetConfiguredRoles()`

`GetConfiguredGuilds()`