Skip to content

Standalone resource for GTAV FiveM servers to add a connection queue.

License

Notifications You must be signed in to change notification settings

IgiCodes/igicore-queue-standalone

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This resource is no longer being actively developed. I will try and keep it functioning but I will not be adding anymore features. The project is being continued as a plugin for NFive

igicore - Queue [Standalone Edition]

Standalone queue system for FiveM servers.

This resource allows players to connect to your server while it's full and queue until there is an available slot.

License Release Version

Download and Installation

Downloads can be found on the Releases page. Follow the instructions on the release on how to install.

Config

Use the igi_queue_config to define the path to the queue settings YAML file. This can be a full path or the path relative to where you launch the server from (e.g. where your startserver.sh is).

sv_maxclients = 32      # Default FiveM convar for max connected players

set igi_queue_config "resources/[IgiCore]/igicore-queue/queueSettings.yml"  # Path to the config file relative to where you launch the server

start igicore-queue # THIS MUST BE AFTER THE ABOVE CONFIG LINES!

Remove the default fivem hardcap resource from your server.cfg. This resource replaces it's functionality and it may interfere.

start hardcap   # remove this from your server.cfg if it's there

YAML Config File

The release zip contains an example for the queueSettings.yml file. This file allows you to specify the disconnect grace period and player priority for players on your server.

PriorityPlayers is a list of players with a custom priority value (Anyone not in this list will default to Priority = 100) DisconnectGrace is how long in seconds a player can disconnect from the queue and keep their spot until they reconnect (Default: 60). DeferralDelay is how often in miliseconds the server will send deferral messages to players in the queue (Default: 500) MaxClients is also an extra value you can specify to override what the queue thinks the server's max client limit is (Default: this will be read from the sv_maxclients convar in your server.cfg). Useful for debugging purposes. QueueWhenNotFull will determine whether or not to queue players even when the server isn't full; essentially only letting one player in at a time (Default: false). ConnectionTimeout is how long in seconds a player can take to connect to the server from the queue (Default 120). Sometimes clients get stuck "connecting" and this causes everyone else to get stuck in the queue until manually reset.

Example file:

PriorityPlayers:  # List of players with a custom priority value (Anyone not in this list will default to Priority = 100)
    - SteamId:  1100001056a8b25 # Igi
      Priority: 10  # Lower number == higher priority

    - SteamId:  1100001056a8b13
      Priority: 50

    # ... More players here

DisconnectGrace: 60   # In Seconds
QueueWhenNotFull: false   # true/false
ConnectionTimeout: 120   # In Seconds

Commands

There are few commands available to you via RCON (or the server terminal), all prefixed with the queue commands.

queue help - Output the all possible commands in the console.

queue status - Output the current queue.

queue clear - Clear the current queue (people will have to reconnect).

queue reload - Reload the queue settings file.

queue add <steamid> - Manually insert a steamid into the queue (useful for debugging purposes).

queue remove <steamid> - Remove a specific steamid from the queue.

queue move <steamid> [position] - Move a specific steamid to a position in the queue (defaults to 1st in queue if not passed a position).

Development

Clone this repo inside your FiveM server's resources directory and build the project in Visual Studio 2017.

Edit your server.cfg file to include the following line below in your existing configuration:

start igicore-queue