Rate Management Plugin - Version 3.3 - Reference
Filename: plugin_blatt_rate
Offline Manual
You are reading this offline manual for this plugin. The links to the right
navigate through the offline information. The links above and to the left
link to www.ravenousbugblatterbeast.pwp.blueyonder.co.uk.
If you downloaded the plugin from somewhere else, or downloaded it some time ago,
I recomend you check for an updated plugin. Note that the on-line manual may have been updated
even if the plugin hasn't.
Player Usage
The player need take no action whatsoever to use this plugin.
Everything is automatic.
Administrator Usage
The rate management plugin provides a number of commands to administrators.#160;
ACCESS_CONFIG level administrator access is required to run all these commands:
#160;
- bbrate_report [ "on" | "off" ]
- If called with no arguments, displays the current configuration. If an argument is supplied,
it switches on/off the automatic display of the report after every other command is issued.
- bbrate_reset
- Changes all settings back to their default values as described on this page.
- bbrate_bandwidth <number> | <number>K
-
This sets the overall quantity of "rate" that is to be shared
between all users on the server. You can specify a rate number as you would on
a client, or use kilobits per second by appending 'K' - e.g. bbrate_bandwidth 256K.
The minimum is 2,048 / 16K and the maximum 1,048,576 / 8192K.
NOTE: It is the lower of your upload and download bandwidths that is the
limiting factor here. Most DSL / cable is only 128K or 256K upload, even if
its 512K/1Mb+ download. Also V.90 56K modems are only 33.6K upload.
- bbrate_mode off | client | server | full
- This setting allows you to set how the plugin controls rate:
- In server mode, rate is controlled by adjusting sv_minrate and sv_maxrate on the server.
- In client mode, rate is controlled by sending commands to change "rate" and "cl_rate" to the client.
- In full mode, both methods are used
Controlling the rate on the server is more reliable and takes effect as soon
as the client connects. Controlling the rate on the client is visible to the
user - they can see what their current rate is and see when it is changed.
The default setting is full mode.
- bbrate_localusers <number>
The number of users playing on the server or on a LAN with the server who
do not use the server's Internet connection when connecting to the server.
The rate of these users will be set to the same as everyone else to ensure
fair play, however they will not be counted when calculating what that rate
should be. Defaults to 1, minimum is 0 and maximum is 32.
NOTE: You should set this to 0 if you are using bbrate_lan to dynamically adjust
the number of local users, unless you have additional local users that are not
on the subnet specified by bbrate_lan - bbrate_lan <IPAddress> <SubnetMask>
Specifies the subnet on which all users should be considered local to the
server. Normally, specifying the server's own IP address and subnet mask
here is sufficient. e.g. bbrate_lan 192.168.1.254 255.255.0.0. Any user who's
IP address matches the specified address when and'ed with the specified mask will
be considered local to the server and will be ignored when computing the
correct rate value.
Using bbrate_lan is preferable to bbrate_localusers, as it dynamically adjusts the
number of local users as they join/leave the server.
NOTE: The 'IPAddress' setting is more accurately the Network address of
the subnet on which the local users are located - if the local users are in
a different address range than the server, it is that network address/mask
you should specify, not that of the server's network interface.
NOTE 2: To disable this feature use: bbrate_lan 0.0.0.0 0.0.0.0
|