Console commands can be executed either using an RCon tool, directly from the server console interface, a server configuration file, the server command line, or (if a resource is allowed by the ACL) the ExecuteCommand function.
Adding a custom RCon command can be done using the RegisterCommand function on the
server, or the (legacy)
Starts the resource specified in the argument, if it was stopped. It is also possible to specify a category name, such as
Stops the resource specified in the argument, if it was started. As with
start, one can also specify a category name.
Restarts the resource specified in the argument, if it was started. If it wasn't, starts the resource specified in the argument.
stop, one can also specify a category name.
Restarts the resource specified in the argument, if it was started. Also supports category names.
Rescans the resources folder and loads all resource manifests in them, also making new resources available to start using start.
Runs the commands specified in the filename, relative to the server data directory, or any resource name specified with
Commonly seen as
FXServer.exe +exec server.cfg.
Exits the server, sending a default quit message to all connected players.
Exits the server, also sending the specified reason to all connected players.
quit "Restarting - will be back soon!"
This is provided by the rconlog resource.
Shows a list of players with their primary identifier, server ID, name, endpoint, and ping.
This is provided by the rconlog resource.
Kicks the client with the specified server ID (as seen in status) from the server, for the stated reason.
clientkick 43 You're a superstitious idiot!
This is provided by the chat resource.
Sends a message in the chat as console.
say Hi, everybody!
Opens or closes the server debug GUI.
Defines the game to run the server for.
FXServer.exe +set gamename rdr3
|LibertyM for GTA:NY
|FiveM for GTA:Five
|RedM for RDR3
Defines which mode of state awareness to use.
Selects a game build for clients to use. This can only be specified at startup, and can not be changed at runtime.
Every build includes all content and changes from the builds before.
|xm18, christmas2018, mpchristmas2018
|The Diamond Casino & Resort
|Diamond Casino Heist
|Los Santos Summer Special
|h4, heist4, mpheist4
|Cayo Perico Heist
|Los Santos Tuners
|The Criminal Enterprises
|Los Santos Drug Wars
|San Andreas Mercenaries
|The Chop Shop
|Mid 2020 update, not compatible with Red Dead Online licenses.
|December 2020 update, works with newer game editions such as RDO.
|July 2021 update, includes new content from Blood Money DLC.
|September 2022 update, limited content/changes.
A variable that specifies the maximum amount of clients that the server can normally have, as an integer from 1 to 2048.
Values starting at 32 will require
onesync to be set to
legacy, and values above 64 will require
onesync to be set to
A boolean variable that, if true, hides player IP addresses from public reports output by the server.
A string variable containing the name of your 'project', which would for example be the server's community. This should be a name, not a list, nor should it contain tags.
Any non-compliant name will be cut off in the server list.
sets sv_projectName "Citizen Gaming"
# or if you are using a premium key, it can contain one color
sets sv_projectName "^6Citizen Gaming"
A string variable containing the description of your project. This should be written as a sentence.
sets sv_projectDesc "Your favorite drug deal simulation community!"
A string variable that contains the server-specific host name. In addition to this, you may want to set
A string variable that can be used to set the server as "private", making it not possible to join by using the server browser UI (the server connect button will be disabled). In the past, this specific string variable dictated where heartbeats were sent and servers weren't listed if the address didn't point to FiveM's ingress address, this is no longer the case, the server will always post to the default server ingress on startup. In other words, this string variable cannot be used to de-list a server from the master list.
Variance is how likely the user's id will change for a given provider (i.e. 'steam', 'ip', or 'license').
A console variable as an integer from 1-5 (default 5); from least to most likely to change.
Trust is how unlikely it is for the user's identity to be spoofed by a malicious client.
A console variable as an integer from 1-5 (default 1); from least to most trustworthy (5 being a method such as external three-way authentication).
This helps counter proxy-based HTTP floods. Levels:
A console variable as an integer from 0-3 (default 0);
A console variable used to block
REQUEST_CONTROL_EVENT routing based on a configurable policy.
Supported modes for this variable are as follows:
sv_filterRequestControlSettleTimer milliseconds (default
30000) - hereafter referred to as 'settled'.
In addition, any mode but 'off' will have some additional checks as well:
con_channelFilters command will list any active channel filters set to the end user.
A channel is the prefix of a console message, for example:
citizen-server-impl, this channel will be displayed in brackets in the console followed by a message, i.e.
[citizen-server-impl] Found 44 resources.
Filters can be used to alter console output behavior.
Different actions exist to alter this behavior:
|Will stop anything from being printed at a trace listener level.
|Will cause the output to be dropped at
Printfv, so it won't reach any print listeners.
drop action behavior and will only drop the output if the developer command is set to
[cmd] forward:*/*: noprint
con_addChannelFilter command will add a channel filter which can be used to filter console channel output.
Regex can be used for channel filters, this can be set through the
filter command parameter.
Available actions are explained up above (con_channelFilters command).
The example down below would stop any channel output coming from script names matching the given pattern.
So the following wouldn't show on the console:
[script:gamemodePrefix-turfs]: Hello world!
[script:gamemodePrefix-derby]: This is a test.
con_addChannelFilter script:gamemodePrefix-* noprint
con_removeChannelFilter command can be used to remove a channel filter, thus removing any previously applied actions (those applied via con_addChannelFilter).
You can use con_channelFilters to check for any active filters.
con_removeChannelFilter script:gamemodePrefix-* noprint
A console variable (default
30000 milliseconds) that allows you to set after how long (based on entity creation time in milliseconds) an entity should be blocked from a
REQUEST_CONTROL_EVENT. This will only apply to filter request control modes 1 and 3, which are detailed under
sv_filterRequestControl in this page.
The time argument must be provided in milliseconds for this to work correctly.
A console variable used to prevent users from using modified client files. There currently are two pure mode levels (1 and 2), an explanation for these levels can be found below:
If modified files are installed in the FiveM folder, they will be ignored - if users however modified base game files, they will receive an error message telling them what file is modified.
A boolean console variable that can be used to prevent users from routing
NETWORK_PLAY_SOUND_EVENT through the server, which is commonly used by malicious actors.
This is set to true by default (allow routing)
A boolean console variable introduced in server version 6831, that is disabled (set to
false) by default.
Enabling it (by setting it to
true), will allow users to route
REQUEST_PHONE_EXPLOSION_EVENT through the server. The main drawback behind enabling this, is that it can also be used by malicious actors.
A console command which loads a specfied icon and sets it as the server icon. The icon needs to be a 96x96 PNG file.
Sets the RCon password. This being unset means RCon is disabled.
Sets a Steam Web API key, which is required to allow for Steam identifiers to be returned by the server.
Adds an access control entry to the server's access control list.
add_ace group.admin command.potato allow
add_ace identifier.steam:110000112345678 command.apple deny
Sets a principal to inherit from another principal.
# makes identifier.steam:110000112345678 inherit from group.admin
add_principal identifier.steam:110000112345678 group.admin
Removes a specified ACE from the server's access control list.
remove_ace identifier.steam:110000112345678 command.apple deny
Removes a specified principal inheritance entry.
remove_principal identifier.steam:110000112345678 group.admin
Tests if a principal is allowed or denied access to a given object.
test_ace group.admin command.adminstuff