Configuration

exec @n4_queue/config.cfg
ensure n4_queue

local queue = exports.n4_queue

---@param name string
---@param deferrals table
local function playerConnecting(name, _, deferrals)
    local source = source

    if IsPlayerBanned(source) then
        return deferrals.done('You are banned from this server!')
    elseif OtherCodeHere(source) then
        return deferrals.done('...')
    end

    -- Optional unique identifier. If omitted, n4_queue will try Utils.getPrimaryIdentifier(source).
    local identifier = 'steam:1234'

    queue:HandleConnection(name, source, deferrals, identifier)
end

AddEventHandler('playerConnecting', playerConnecting)

# set "Website" "https://servers.fivem.net"
# set "Discord" "https://discord.com"

# Locale for the queue system
set "queue:locale" "en"

# Initial amount of time (in seconds) that players will be held in the queue on server startup before being allowed to load into the server
set "queue:server_startup_delay" 60

# Amount of time (in seconds) to wait in-between each player loading into your server
set "queue:connection_delay" 1

# Adds the queue count in front of your server name on the cfx public server list (0 = disabled, 1 = enabled)
set "queue:modify_hostname" 0

# If enabled, combine all rows/roles of prio together, otherwise, only use the row/role with the highest amount of points (0 = disabled, 1 = enabled)
set "queue:stack_priority" 1

# Gives players temporary priority points after they disconnect. useful if players crash, etc (0 = disabled, 1 = enabled)
set "queue:grace_priority_enabled" 0

# The amount of temporary priority points a player receives after they disconnect
set "queue:grace_priority_points" 1000

# The amount of time in seconds that a player has to re-connect to the server before their grace priority expires
set "queue:grace_priority_timer" 180

# Manually handle the queue connection process in an external resource through exports (0 = disabled, 1 = enabled)
set "queue:manual_connection" 0

# Enable Discord integration (0 = disabled, 1 = enabled)
set "queue:discord:enabled" 0

# The guild ID of your Discord server
set "queue:discord:guild_id" ""

# Require the player to have a Discord identifier to connect (0 = disabled, 1 = enabled)
set "queue:discord:require_identifier" 0

# Require the player to be in your Discord server to connect (0 = disabled, 1 = enabled)
set "queue:discord:require_in_guild" 0

# Enable Discord role whitelist (0 = disabled, 1 = enabled)
set "queue:discord:whitelist_enabled" 0

# The role IDs that players need to have in order to connect if whitelist is enabled
set "queue:discord:whitelist_role_ids" ["123", "1234", "1345"]

# Discord role ID to priority points (object: role ID -> points)
set "queue:discord:prio_roles" {
  "123": 5000,
  "1234": 2500,
  "1345": 1000
}

# Use the player's nickname from Discord instead of their username (0 = disabled, 1 = enabled)
set "queue:discord:use_nickname" 0

# When whitelist or require_in_guild is enabled and the Discord/API request fails:
# 1 = allow player to connect anyway (fail open), 0 = block with discord_api_unavailable message (fail closed)
set "queue:discord:allow_on_api_failure" 1

# The fallback avatar to use if the player's avatar is not found
set "queue:fallback_avatar" "https://cdn.n4.gg/misc/default-user.webp"

# Logo image URL shown on the queue card (default card and subpages)
set "queue:logo_url" "https://cdn.n4.gg/branding/blue-512.png"

# Queue card: name of the card file (without .json) in the cards/ folder.
set "queue:card" "default"

# Number of players shown on the "Queue list" subpage card (1–50)
set "queue:queue_list_display" 15

# How often (in seconds) the queue card is refreshed for each waiting player (1 = every second).
set "queue:card_refresh_interval" 1

# How often (in seconds) the "Queue list" subpage is rebuilt (minimum 5).
set "queue:queue_list_refresh" 10

# Reserved slots: this many slots are never filled by the queue.
set "queue:reserved_slots" 0

# Bypass queue: identifiers in this list skip the queue and can use reserved slots.
set "queue:bypass_identifiers" "[]"

# Enable console logging (0 = disabled, 1 = enabled)
set "queue:console_logging" 1

# Enable debug mode (0 = disabled, 1 = enabled)
set "queue:debug" 0

# These are the convars the queue uses for the website and Discord links shown on the queue card.
# Uncomment below to set them here, or set them in your server.cfg to reuse across other resources.
# set "Website" "https://servers.fivem.net"
# set "Discord" "https://discord.com"