The Ravenous Bugblatter Beast of Traal
Stupid, but extremely ravenous!

Name Management Plugin - Version 3.3 - Reference

Filename: plugin_blatt_name

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

There is nothing for the players to do in order to use this plugin, except maybe change their name if theirs is rejected and they don't like the new one the plugin assigns them.

Administrator Usage

The following commands can be issued from the console by an admin with ACCESS_CONFIG. All settings will be remembered between server restarts.

All commands will also echo the current settings for every command to the administrator's console.

bbname_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.
bbname_reset
Changes all settings back to their default values as described on this page.
bbname_rename on | off

Enables / disables the renaming of players that do not match the acceptance criteria. The criteria are:

  • The name must not appear in the file badplayernames.ini
  • The name must meet the minimum length requirement
  • The name must meet the requirement for a minimum length sequence of consecutive upper or lower case letters (a-z).

When enabled, if a player name does not meet the criteria, it is replaced with a random name from newplayernames.ini. However, if the only criteria it fails to meet is the minimum number of consecutive of alphabetic characters an attempt will be made to "de-leet" the name before resorting to replacing it entirely. Leet is the practice of replacing letters with punctuation that looks like the letter - e.g. '4$$4$$1|\|' is leet for 'Assassin'. If the "de-leeted" name is valid, this is used as the new name instead of one from newplayernames.ini.

The default setting is "on"

bbname_minlength <n>
Sets the minimum acceptable name length. This limit is only enforced when bbname_rename is set to "on;". The default value is 3, the minimum 0 and the maximum 16
bbname_minletters <n>
Sets the minimum acceptable number of consecutive letters. This limit is only enforced when bbname_rename is set to "on;". e.g. If bbname_minletters was set to 4, 'fred' would be legal name, but 'jim' and 'fr3d' would both be rejected. The default value is 1, the minimum 0 and the maximum 16
bbname_changes on | off | <n>>

Allows players to change their name mid-game. When set to "off", if a player changes their name, it will be changed back, unless their previous name was given to them by this plugin because their chosen name was invalid. In this case, the user will be permitted to change their name to a valid name of their own choosing. If set to "on", players can freely make as many changes as they want. If set to a number, players can change their name the specified number of times after which no further changes are permitted.

To completely disable renaming, set bbname_rename to off and bbname_changes to off.

bbname_lantagmask <ipaddress>

Configures the network mask that is used to determine if two or more players are playing on the same LAN. If players are on a LAN, it is likely that they can see each others screens (ghosting) allowing them to cheat when one is dead.

When set to a valid subnet mask this will enable LAN detection. Although any subnet mask can be used, there are only really 3 that are likely to be useful:

  • 255.255.255.255 will flag players as being on the same LAN if they connect through the same router that is performing network address translation (e.g. Windows Internet Connection Sharing).
  • 255.255.255.0 will flag players as being on the same LAN if they have the first 3 numbers the same in their IP addresses. This setting will flag more often, but may occasionally get it wrong - e.g. If two dial-up users connect from the same ISP and are assigned modems on the LAN at the ISP.
  • 0.0.0.0 will disable LAN detection. Use this setting if you are running a private LAN only server as everyone will be on a LAN and everyone will already know that without a plugin telling them!
bbname_lantags on | off

Enables / disables the renaming of players that are on the same LAN by prefixing their names with "Ln:" where n is a number indicating which group(s) of players are together.

bbname_autochasecam 0 | 1 | 2
If set to 1 or 2, the plugin will set mp_forcechasecam to the same value whenever two or more players are detected as playing from the same LAN. When all players are on separate LANs, mp_forcechasecam will be set to 0 allowing free look.

Any changes made to these settings are retained permanently even if the server is restarted, or crashes.

Immunity

In order to prevent admins from being denied access to their admin commands, all features that modify a player's name are disabled if the player in question has ACCESS_IMMUNITY.

File Locations

The plugin first searches for badplayernames.ini and newplayernames.ini in your addons/adminmod/config directory. If they are not found, it then looks in your mod folder.