From 0cefb34786f9d9b6ab39cfaaec197f8a81a8bcd3 Mon Sep 17 00:00:00 2001 From: Andriy Logvin Date: Mon, 9 Sep 2024 17:38:40 +0100 Subject: [PATCH] docs(server/commands): Document increase_pool_size command --- content/docs/server-manual/server-commands.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/content/docs/server-manual/server-commands.md b/content/docs/server-manual/server-commands.md index baccf540..d7e87816 100644 --- a/content/docs/server-manual/server-commands.md +++ b/content/docs/server-manual/server-commands.md @@ -403,6 +403,27 @@ Sets the RCon password, if unset then RCon will be disabled. FXServer RCon uses Sets a [Steam Web API key](https://steamcommunity.com/dev/apikey), which is required to allow for Steam identifiers to be returned by the server. +### `increase_pool_size [poolName] [increase]` + +Increases size of the given pool. May be used more than once to increase size of multiple pools. + +- `poolName` - a string indicating which pool should be increased in size. +- `increase` - positive integer indicating by how much the pool size should be increased. + +Example: +``` +increase_pool_size "Peds" 123 +increase_pool_size "CWeapon" 1234 +``` + +This can only be specified at startup, and can not be changed at runtime. To join servers with different pools sizes client would have to restart the game - similarly to how it works with `sv_enforceGameBuild` and `sv_pureLevel`. + +Pool size increase requests are validated on the server and client side. On the server side, if the pool is not allowed to be resized or the size increase exceeds the allowed limit - the command will have no effect and warning message will be displayed in the logs. On the client side - the client will not be able to connect to a server that requests invalid pool sizes (this should only happen if the server bypassed the server side check somehow). + +Set of allowed pools and the maximum size increase per pool are set in `content.cfx.re`. Both server and client fetch the limits on startup for updates. + +You can explore current pools and their sizes using `F8 > Tools > Streaming > Pool Monitor` tool. + ## Access control commands ### `add_ace [principal] [object] [allow|deny]`