Server commands
VU servers support most of the commands that vanilla BF3 servers also support. You can find a listing of all of them in this document. Everything that is not Punkbuster or reserved slots related should work. On top of those, VU servers have a few custom commands which are listed below:
Mod list
modList.Add
Adds a mod to the list of mods to load on the next server restart and saves the changes to the ModList.txt
file. This will not load the mod immediately.
modList.Available
Lists the mods that are available to be added to the mod list.
modList.Clear
Clears the list of mods to loads on the next server restart and saves the changes to the ModList.txt
file. This will not unload any currently running mods.
modList.Debug
Accepts a single boolean argument (true
or false
) which toggles debug mode for any loaded extensions. When set to true
, any scripts will be built with debug symbols enabled, which will make it so errors printed on the server and the clients will contain more useful information about their source.
When used with no arguments, it returns whether debug mode is currently enabled or not. Defaults to false
.
modList.List
Lists the mods to load on the next server restart. This basically lists all mods present in the ModList.txt
file and may not be the same as the list of mods that are currently running.
modList.ListRunning
Lists all currently loaded / running mods.
modList.ReloadExtensions
Reloads all currently loaded mods. Keep in mind that this can cause significant server and client lag and also crashes as not all mods support reloading.
modList.Remove
Removes a mod from the list of mods to load on the next server restart and saves the changes to the ModList.txt
file. This will not unload any currently running mods.
Venice Unleashed
vu.ColorCorrectionEnabled
Accepts a single boolean argument (true
or false
) that specifies whether the blue-tint filter should be enabled or not.
When used with no arguments, it returns whether the blue-tint filter is enabled or not.
vu.DesertingAllowed
Accepts a single boolean argument (true
or false
) which specifies whether players are allowed to exit the combat area or not. When set to true
the combat area will be disabled and players will not be killed for exiting it.
When used with no arguments, it returns whether deserting (leaving the combat area) is allowed or not. Defaults to false
.
vu.DestructionEnabled
Accepts a single boolean argument (true
or false
) which toggles destruction. When set to false
, all destruction on the server will be disabled.
When used with no arguments, it returns whether destruction is currently enabled or not. Defaults to true
.
vu.FadeInAll
Fades the screen of all the currently connected players from black back to normal.
vu.FadeOutAll
Fades the screen of all the currently connected players to black.
vu.FrequencyMode
Returns the current server frequency mode. For 30Hz it returns regular
, for 60Hz it returns high60
and for 120Hz it returns high120
.
vu.HighPerformanceReplication
Accepts a single boolean argument (true
or false
) that specifies whether high performance replication should be enabled or not. Normally, the server will reduce the amount of updates it sends for players that are further away from other players. Setting this to true
will make the server send updates at the same rate for all players. This also results in an increase in network activity.
When used with no arguments, it returns whether high performance replication is enabled or not. Defaults to false
.
vu.ServerBanner
A URL pointing to a custom server banner image that will be shown to users in the VU server browser. This must be an http or https URL pointing to a JPEG image with the .jpg
extension. The recommended resolution for banner images is 1378x162
. Using inappropriate or hateful images will result in your server being delisted and your server hosting privileges being revoked.
vu.SetTeamTicketCount
Accepts two arguments: a team number and the number of tickets that team should have. For example, to set the tickets of team 1
to 120
you would execute the following command: vu.SetTeamTicketCount 1 120
vu.SpectatorCount
Lists the number of spectators currently connected to the server.
vu.SquadSize
Accepts a single integer argument (1
or higher) which sets the maximum amount of players per squad.
When used with no arguments, it returns the current squad size.
vu.SunFlareEnabled
Accepts a single boolean argument (true
or false
) that specifies whether the sun flare should be enabled or not.
When used with no arguments, it returns whether the sun flare is enabled or not.
vu.SuppressionMultiplier
Accepts a single integer argument (0
or higher) that specifies a multiplier for the suppression effect. Setting this to 0
completely disables suppression (both visually and for weapon spread).
When used with no arguments, it returns the current suppression multiplier. Defaults to 100
.
vu.FriendlyFireSuppression
Accepts a single boolean argument (true
or false
) that specifies whether friendly fire should be suppressed as well.
When used with no arguments, it returns whether friendly fire suppression is enabled or not. Defaults to false
.
vu.TimeScale
Accepts a single numeric argument (0.0
to 2.0
) that specifies the relative time scale for all players. Values lower than 1.0
make the game slower, values higher 1.0
make the game faster.
When used with no arguments, it returns the current time scale. Defaults to 1.0
.
vu.VehicleDisablingEnabled
Accepts a single boolean argument (true
or false
) which toggles whether vehicles can enter the disabled state or not. When set to false
, vehicles will no longer get disabled (and drain health) when they reach low health status.
When used with no arguments, it returns whether vehicle disabling is enabled or not. Defaults to true
.
vu.Fps
Returns the current FPS of the server.
vu.FpsMa
Returns the 30-second moving average of the server FPS. If this value falls below frequency-hz * 1.1
then a performance warning indicator will be shown next to your server in the server browser.
vu.HttpAssetUrl
A URL pointing to an external HTTP server hosting mod assets, or an empty string if assets should be sent directly from the game server. When this is set, any connecting clients will try to download any needed assets from that URL, following the file structure of the mod files. For example, if you have a mod called mymod
and it has a WebUI container file (ui.vuic
), and you set the URL to https://example.com/assets/
, the client will try to download the file from https://example.com/assets/mymod/ui.vuic
. If file downloads fail or their contents don't match what's on the game server, clients will be unable to join.
vu.DisablePreRound
Accepts a single boolean argument (true
or false
). This has to be used before the level gets loaded. When set to true
the preround will be disabled on the next level (re)load.
This command can be used in the Startup.txt
to disable the preround. To reenable the preround just set it back to true
and reload the level.
Default is set to false
.
When used with no arguments, it returns whether preround is disabled or not.
vu.TeamActivatedMines
Allows you to control whether team members can trigger claymores and other mines.
Accepts a single boolean argument, either true
or false
, to toggle the feature on or off.
The default setting is false
, meaning team members cannot trigger claymores and other mines by default.
When used with no arguments, it returns the current state of whether team members can trigger claymores and other mines or not.
vu.CorpseDamageEnabled
Enables or disables the ability to deal damage to a corpse, preventing revival.
Accepts a single boolean argument, either true
or false
, to control whether damage to a corpse is permitted or not. (Tip: Tweak VeniceSoldierHealthModuleData.manDownStateHealthPoints
with a mod.)
The default setting is false
, which means that damage to a corpse is disabled by default.
When used with no arguments, it returns the current state of whether damage to a corpse is enabled or disabled.