FiveM Convars Definitions
set rateLimiter_stateBag_rate
This ConVar sets the rate limit for state bag change packets that can be sent per second. State bags are used to synchronize state data between clients and the server.
Usage:
To set this ConVar, include the following line in your server configuration:
Replace
[value]
with the desired number of packets per second (default is75
).
Useful For:
Preventing network congestion by limiting the rate of state synchronization packets.
Enhancing server stability by avoiding potential memory exhaustion due to excessive state changes.
set rateLimiter_stateBag_burst
This ConVar defines the burst limit for state bag change packets. The burst limit allows a temporary exceedance of the standard rate limit to accommodate sudden spikes in state changes.
Usage:
To set this ConVar, add the following line to your server configuration:
Replace
[value]
with the desired burst limit (default is125
).
Useful For:
Allowing flexibility in state synchronization during peak activity periods.
Maintaining performance by controlling the maximum burst of state change packets.
set rateLimiter_stateBagFlood_rate
This ConVar sets the rate limit for what is considered a "flood" of state bag change packets. Exceeding this rate may indicate a potential abuse or malfunction.
Usage:
To configure this ConVar, include the following line in your server configuration:
Replace
[value]
with the desired flood detection rate (default is150
).
Useful For:
Detecting and mitigating potential abuse or misconfigurations leading to excessive state changes.
Protecting server resources by identifying and handling clients that exceed normal usage patterns.
set rateLimiter_stateBagFlood_burst
This ConVar defines the burst limit for what is considered a "flood" of state bag change packets. Exceeding this burst limit may trigger protective measures, such as disconnecting the offending client.
Usage:
To set this ConVar, add the following line to your server configuration:
Replace
[value]
with the desired flood burst limit (default is175
).
Useful For:
Implementing safeguards against clients that may cause instability through excessive state changes.
Maintaining overall server health by controlling sudden surges in state synchronization traffic.
sv_replaceExeToSwitchBuilds
This server-side ConVar determines whether the server should replace the executable to switch game builds dynamically. This is particularly useful for servers that need to change game builds without restarting the entire server.
Usage:
To set this ConVar, add the following line to your server configuration:
Replace
[value]
withtrue
to enable orfalse
to disable this feature.
Useful For:
Facilitating seamless transitions between different game builds.
Reducing downtime associated with server restarts when changing game builds.
sv_enableNetworkedScriptEntityStates
Networked Script Entity States: These are states or data associated with entities (like vehicles, players, or objects) that are managed and synchronized across all connected clients via the server. This allows scripts to share custom state information about an entity with all clients.
Usage:
sv_enableNetworkedScriptEntityStates 0
: Disables networked script entity states. Scripts will not be able to assign or synchronize custom state data across clients.sv_enableNetworkedScriptEntityStates 1
: Enables networked script entity states, allowing scripts to synchronize custom data for entities between all clients.
Why It’s Useful:
Custom State Sharing: Scripts can use this to assign and share additional data or "states" to specific entities, such as custom metadata for vehicles, NPCs, or objects.
Example: A car might have a "locked" state shared across clients, so all players see the same lock status.
Server-Side Authority: The server ensures that all clients receive consistent data, preventing desynchronization issues.
Enhances Script Functionality: This is especially useful in RP (Roleplay) servers or complex game modes that rely on synced, state-based interactions.
Performance Considerations:
Enabling this ConVar may increase the amount of data being synchronized between the server and clients, which could have a slight impact on performance for very busy servers with many entities.
sv_filterRequestControl
Purpose: It determines whether the server will filter requests from clients to take control of certain entities. These entities could be vehicles, objects, or peds (NPCs) in the game world.
Usage:
sv_filterRequestControl 0
: Disables the filter, allowing all clients to request control of entities without restriction.sv_filterRequestControl 1
: Enables the filter, meaning the server will apply restrictions to decide whether a client is allowed to take control of an entity.
Why It's Important:
Prevent Exploits: Filtering requests can help mitigate certain exploits where clients attempt to gain control of entities they shouldn't be interacting with, such as griefing other players or taking over server-owned entities.
Improve Stability: It ensures better control over entity management, leading to fewer conflicts and smoother server performance.
Default Setting:
The default value for this ConVar is typically 0
(disabled), but you can enable it (1
) to add an extra layer of control over how clients interact with entities on the server.
seta "cl_rcdFailureBackoff"
This is a client-side variable controlling how the client should handle backoff (delayed retries) in response to failures during the Reliable Command Dispatch (RCD) process. Setting it to 0
means there will be no backoff, and retries happen immediately.
Usage:
"0"
: Disables the backoff, causing instant retries.Other values (if applicable): Introduce delays to prevent overwhelming the server or connection.
Useful For: Reducing delays in retry mechanisms for commands. However, it might increase traffic during unstable conditions.
set sv_listingHostOverride
Overrides the host listed in server directories or for query purposes. Instead of the actual server's hostname or IP, this allows specifying a custom hostname.
Usage:
Commonly used for hiding the real IP or displaying a vanity address (e.g.,
play.mygameserver.com
).
Useful For: Servers using proxies or load balancers or wanting to improve branding with a custom domain.
sv_exposePlayerIdentifiersInHttpEndpoint
When enabled, player identifiers (Steam, Rockstar, Discord, etc.) are included in HTTP endpoints exposed by the server for external tools or scripts.
Usage:
0
: Disables exposing player identifiers.1
: Enables exposing player identifiers in HTTP endpoints.
Useful For: Integrating third-party tools, such as bans, logs, or analytics systems, requiring player identifier access.
set sv_kick_players_cnl
Configures whether the server should kick players when their connection is lost (cnl
- connection loss).
Usage:
0
: Does not kick players immediately after a connection loss.1
: Automatically kicks players after detecting connection loss.
Useful For: Controlling whether disconnected players should be kicked immediately or given time to reconnect.
sv_httpHandlerConnectionTimeoutSeconds
Sets the timeout (in seconds) for HTTP handler connections made to the server.
Usage:
Adjust the timeout value based on how long you want the server to wait for responses from HTTP endpoints.
Useful For: Ensuring timely responses from external APIs without causing long server delays.
sv_tcpConnectionTimeoutSeconds
Configures the timeout for TCP connections to the server. If a client or service doesn't respond within this time, the connection is terminated.
Usage:
Default values work for most cases but can be adjusted for high-latency environments.
Useful For: Preventing stalled or hung connections from consuming server resources.
sv_forceIndirectListing true
The "sv_forceIndirectListing true" setting in the FiveM server configuration file forces the
Forces the server to use an indirect listing method for server discovery, typically useful for servers behind NAT or proxies.
Usage:
0
: Default direct listing.1
: Forces indirect listing.
Useful For: Servers in complex network setups (e.g., using NAT or GRE tunnels) to ensure they are visible in server browsers.
sv_listingIpOverride "1.2.3.4"
The "sv_listingIpOverride" setting in the FiveM server configuration file specifies the IP
Overrides the IP address shown in server listings. Instead of the server's actual IP, you can specify a different public IP.
Usage:
Useful when the server has multiple IPs or sits behind a proxy.
Useful For: Setting a public-facing IP different from the actual host's IP.
sv_endpoints "1.2.3.4:30120"
Specifies custom endpoints for the server to bind to, such as IP addresses and ports.
Usage:
Example:
set sv_endpoints "127.0.0.1:30120"
Useful For: Configuring specific interfaces and ports the server listens on.
sv_endpointurl
Sets the URL the server communicates with for specific tasks, such as API callbacks.
Usage:
Example:
set sv_endpointurl "https://api.myserver.com/callback"
Useful For: Integrating with external APIs or tools.
sv_requestParanoia
Configures the level of paranoia for handling network requests, focusing on stricter validation.
Usage:
0
: Default behavior with minimal validation.Higher values: Enforces stricter checks, reducing the chance of malformed or malicious requests.
Useful For: Increasing server security against potential exploits.
sv_pureLevel
Console variable used to prevent users from using modified client files. There currently are
files.
Usage:
0
: No file integrity checks.1
: Basic integrity enforcement.2
: Strict file checks, rejecting all mismatched files.
Useful For: Ensuring fair gameplay by preventing modified files or cheating tools.
sv_enforceGameBuild
This ConVar allows server owners to enforce a specific game build for all connecting clients. Game builds correspond to different versions of GTA V, each introducing new features, vehicles, and map updates.
Usage:
To set this ConVar, add the following line to your server configuration:
Replace
[build_number]
with the desired build number (e.g.,2189
,2372
).
Useful For:
Ensuring all players experience the server with the same game features and content.
Preventing compatibility issues arising from clients running different game versions.
Leveraging new GTA V content and features in server scripts and resources
txAdmin
The txAdmin menu has a variety convars that can alter the default behavior of the menu. Convars configured in the settings page should not be set manually.
Settings page only
txAdmin-menuEnabled
Description: Whether the menu is enabled or not. Changing it requires server restart.
Default:
true
txAdmin-menuAlignRight
Description: Whether to align the menu to the right of the screen instead of the left.
Default:
false
txAdmin-menuPageKey
Description: Will change the key used for changing pages in the menu. This value must be the exact browser key code for your preferred key. You can use this website and the
event.code
section to find it.Default:
Tab
txAdmin-hideDefaultAnnouncement
Description: Suppresses the display of announcements, allowing you to implement your own announcement via the event
txAdmin:events:announcement
.Default:
false
txAdmin-hideDefaultDirectMessage
Description: Suppresses the display of direct messages, allowing you to implement your own direct message notification via the event
txAdmin:events:playerDirectMessage
.Default:
false
txAdmin-hideDefaultWarning
Description: Suppresses the display of warnings, allowing you to implement your own warning via the event
txAdmin:events:playerWarned
.Default:
false
txAdmin-hideDefaultScheduledRestartWarning
Description: Suppresses the display of scheduled restart warnings, allowing you to implement your own warning via the event
txAdmin:events:scheduledRestart
.Default:
false
Convar only (not in settings page)
txAdmin-debugMode
Description: Will toggle debug printing on the server and client.
Default:
false
Usage:
+setr txAdmin-debugMode true
txAdmin-menuPlayerIdDistance
Description: The distance in which Player IDs become visible, if toggled on. Note that the game engine limits to show tags that are only closer than ~300m, so increasing the number above that might be useless.
Default: 150
Usage:
+setr txAdmin-menuPlayerIdDistance 100
txAdmin-menuDrunkDuration
Description: How many seconds the drunk effect (troll action) should last.
Default: 30
Usage:
+setr txAdmin-menuDrunkDuration 120
txAdmin-menuPtfxDisable
Description: Determine whether to not play particles effects whenever an admin's player mode is changed.
Default:
false
Usage:
+set txAdmin-menuPtfxDisable true
txAdmin-menuAnnounceNotiPos
Description: Determines the location of the txAdmin announcement notification. This must use one of the following valid positions,
top-center
,top-left
,top-right
,bottom-center
,bottom-left
,bottom-right
.Default:
top-center
Usage:
+set txAdmin-menuAnnounceNotiPos top-right
Last updated