Comprehensive Guide to FiveM ConVars

Comprehensive Guide to FiveM ConVars
Enhance your FiveM server management with these ConVar definitions and usage explanations.

Author: Goodleaf Hosting

FiveM ConVars (configuration variables) provide a flexible way to customize and manage server settings. From listing configurations to security features, understanding these variables will help you optimize your server for performance, security, and user experience.

General Server ConVars

1. set sv_listingHostOverride

   • Purpose: Replaces backend endpoints with a custom one.
   • Example Usage:

     set sv_listingHostOverride https://play.myrpserver.com
     

2. sv_exposePlayerIdentifiersInHttpEndpoint

   • Purpose: Enables backward compatibility by exposing player identifiers in the players.json endpoint.
   • Default: Off.

3. set sv_kick_players_cnl 0

   • Purpose: Resolves the "Connection CNL timed out" error.

4. sv_httpHandlerConnectionTimeoutSeconds

   • Purpose: Sets the timeout for HTTP request handlers.
   • Default: 300 seconds (5 minutes).

5. sv_tcpConnectionTimeoutSeconds

   • Purpose: Configures the timeout for TCP connections.
   • Default: 5 seconds.

Security and Privacy ConVars

1. sv_forceIndirectListing

   • Purpose: Lists the server indirectly in the FiveM browser, protecting it from direct attacks.
   • Usage:

     sv_forceIndirectListing true
     

2. sv_listingIpOverride

   • Purpose: Specifies the IP address used when listing the server. Useful for NAT setups or multiple IPs.
   • Example Usage:

     sv_listingIpOverride "1.2.3.4"
     

3. sv_endpoints

   • Purpose: Defines the endpoint address (IP and port) for server connections.
   • Example Usage:

     sv_endpoints "1.2.3.4:30120"
     

4. sv_endpointurl

   • Purpose: Allows specifying a custom URL for the endpoint.

5. sv_requestParanoia

   • Purpose: Protects the server against HTTP-based proxy floods.
   • Levels:
     • 0: Default behavior.
     • 1: Blocks requests with a "Via" header.
     • 2: Blocks requests with "Upgrade-Insecure-Requests" headers.
     • 3: Blocks the socket the request is submitted on.
   • Recommendation: Set to level 3 for maximum protection.
   • Usage:

     sv_requestParanoia 3
     

6. sv_pureLevel

   • Purpose: Prevents modified client files.
   • Levels:
     • 1: Blocks all modified files except audio and known graphic mods.
     • 2: Blocks all modified files.

txAdmin-Specific ConVars

Settings Page Only

1. txAdmin-menuEnabled

   • Purpose: Enables or disables the txAdmin menu.
   • Default: true.

2. txAdmin-menuAlignRight

   • Purpose: Aligns the menu to the right of the screen.
   • Default: false.

3. txAdmin-menuPageKey

   • Purpose: Configures the key for changing menu pages.
   • Default: Tab.

4. txAdmin-hideDefaultAnnouncement

   • Purpose: Suppresses default announcements, allowing custom ones.
   • Default: false.

5. txAdmin-hideDefaultDirectMessage

   • Purpose: Suppresses default direct message notifications.

6. txAdmin-hideDefaultWarning

   • Purpose: Suppresses default warning messages.

7. txAdmin-hideDefaultScheduledRestartWarning

   • Purpose: Suppresses default scheduled restart warnings.

ConVar Only (Not in Settings Page)

1. txAdmin-debugMode

   • Purpose: Toggles debug mode for server and client.
   • Default: false.
   • Usage:

     +setr txAdmin-debugMode true
     

2. txAdmin-menuPlayerIdDistance

   • Purpose: Sets the distance for displaying player IDs.
   • Default: 150.
   • Usage:

     +setr txAdmin-menuPlayerIdDistance 100
     

3. txAdmin-menuDrunkDuration

   • Purpose: Sets the duration of the drunk effect for troll actions.
   • Default: 30 seconds.
   • Usage:

     +setr txAdmin-menuDrunkDuration 120
     

4. txAdmin-menuPtfxDisable

   • Purpose: Disables particle effects when admin player mode changes.
   • Default: false.
   • Usage:

     +set txAdmin-menuPtfxDisable true
     

5. txAdmin-menuAnnounceNotiPos

   • Purpose: Configures the location of announcements on the screen.
   • Default: top-center.
   • Usage:

     +set txAdmin-menuAnnounceNotiPos top-right
     

Conclusion

By using these ConVars, you can enhance your FiveM server’s functionality, improve security, and tailor the experience for both admins and players. For additional customization or troubleshooting, always refer to the FiveM or txAdmin documentation.

Need reliable hosting? Goodleaf Hosting offers optimized servers with full support for advanced FiveM configurations. Upgrade your server today!