In Game: Teo
Joined: Sep 21, 2009
Last Visit: May 23, 2017
Medals: 6 (View more...)
|Posted: Mon Apr 08, 2013 8:26 am
Post subject: Commands And Settings PunkBuster™
| The use of PunkBuster commands and settings is optional. This information is provided for advanced users who want to get more out of the PunkBuster software or who want to customize it. A brief overview of using commands and settings is given, as well as a reference list of all available commands and settings along with explanations of their correct use.
The most common way to enter a command or to check / change a setting in PunkBuster is to bring down the Game Console and type away. However, since PunkBuster is directly integrated into the game, PunkBuster commands and settings can also be treated just like any other game command or setting in that they can be placed into game script files, bound to keystrokes and used in aliases.
The easiest way to quickly test that your PunkBuster system is properly installed, Enabled, and working is to type "PB_VER" into the game console. If PunkBuster is working properly, it will respond by displaying the version number that is currently installed and running. If there is no response, then PunkBuster is either currently Disabled or there is a problem that may require some troubleshooting. Consult the FAQ (Frequently Asked Questions) Appendix later in this publication for suggestions on ways to troubleshoot this type of problem.
Some commands are standalone and others may require or accept additional parameters. For example, the command "PB_VER" is standalone, typing in "PB_VER" tells PunkBuster that you would like to know the currently running Version number. The command "PB_LOAD" takes one parameter (a filename), typing in "PB_LOAD ABC.CFG" tells PunkBuster to load the configuration file called "ABC.CFG".
PunkBuster settings, sometimes also called variables, hold numbers or textual information that PunkBuster uses while it is operating. Changing PunkBuster settings will affect the way PunkBuster runs in specific ways. All PunkBuster settings start out with default values that are the recommended setting values for most users. To find out the current value of a setting, simply type in the name of the setting all by itself. For example, typing "PB_LOGTOFILE" will cause PunkBuster to display the current value. Also displayed is the allowable range that the value can contain. This particular setting can be set either to 1 or 0 and 0 is the default. To set it to 1, type in "PB_LOGTOFILE 1", PunkBuster will then respond by showing the setting name along with its new value. Trying to set a PunkBuster setting outside of its allowable range will cause PunkBuster to give the setting the closest allowable value to what was originally specified.
Listed below (in alphabetical order) is a list of PunkBuster Commands and Settings along with a general description and usage instructions where necessary.
Searches through all of your game key bindings for the specified [search_text] and reports on the findings; this is useful if you want to see which key(s) is/are currently bound to which action(s)
Disables the PunkBuster Client Software - the disabling does not take effect until the game is exited and restarted
Enables the PunkBuster Client Software
Sends a request to the connected Game Server and then displays the results of the request; used by Players to find out the current value of Game Server settings (cvars); client queries using pb_cvarval are ignored if the text "pass" is in the query
Displays the allowed cvar ranges for any cvars that the Game Server is monitoring; see the section dealing with the Variable Monitoring Facility
Searches through all of your game cvar (variable) values for the specified text and reports on the findings; this is useful if you want to see which cvars currently contain certain commands
Captures and saves a screen shot based on the parameters found in the PB_SSOPTIONS setting listed below; described more fully in the Screen Capture Facility section
PB_Kick [slot #]
Requests that a specific player be removed from the game; this command is part of the PB Player Power facility
PB_Load [File Name]
Loads the specified PunkBuster config file which can contain commands and/or setting changes
Displays your PunkBuster GUID and your Game CDKey (Note: Cdkey is not shown if currently connected to a server); The GUID is used by PunkBuster to identify players and it is based on the CDKey entered into the game
Requests that the connected PunkBuster Server display a list of players and their current status to the console
Requests that the connected PunkBuster Server display a list of players and their current PB Player Power status to the console
Sets and/or displays the parameters used for taking local PunkBuster Screenshots; used by the Screen Capture Facility
Displays the currently running version of the PunkBuster Client software
This command adds the PBWEB functionality directly into the PB Client - PBWEB should no longer be required to manually update PB clients. PunkBuster will automatically issue this command when necessary to auto-update during gameplay before going into distress mode
Writes the current values of the PunkBuster settings to the local hard drive (creating or overwriting files called pbcl.cfg and pbcllog.cfg) in such a way that they will be loaded automatically the next time PunkBuster starts; if you make changes to your PunkBuster settings and you want the changes to be permanent, then enter this command after making the changes
Holds the name of a game script file that is to be executed each time a server is joined; This is useful if you need to reset game settings each time you join a server
PB_CDKeyVerAuto [0=no, 1=yes]
Setting defaults to 0. When set to 1, PB issues a pb_cdkeyver command automatically upon attempting to connect to a server. This is useful for players who have certain routers that randomly drop OOB packets and cause the GUID: UNKN kicking on PB servers
Defaults to 0; when set to 1, PB will behave as though it has no Internet access
PB_LogAddr [Address / Internet Hostname]
Holds the address of the machine to which remote logging is sent (default is empty meaning the feature is not used)
Defaults to 0; setting to 1 will cause PB to log all MD5Tool file check query replies sent to connected PB Servers during gameplay
PB_LogPort [Port #]
Holds the listen port of the machine to which remote logging is sent (default is 0 meaning the feature is not used)
Holds the password required to send logging output to a listening remote logging machine
PB_LogToFile [0=no, 1=yes]
When set to 1, PunkBuster will log activity to the pbcl.log file; the default is 0 which means only errors are logged
Holds the username required to send logging output to a listening remote logging machine
PB_MsgPrefix [New Prefix]
Holds the text that PunkBuster displays in front of every output line displayed; the default is "^5PunkBuster Client" (note the ^5 means output in the color LIGHT BLUE); All PunkBuster Client output goes to both the top of the playing screen and to the console by default; To prevent PunkBuster Client messages from being displayed on the playing screen, insert the "at-sign": @ before any desired message prefix text. For example, the command pb_msgprefix @^5PunkBuster Client will cause all PunkBuster Client output to go only to the console and not to the playing screen.
PB_Security [0=no, 1=yes]
When set to 0, PunkBuster will accept all "update" files without verifying that they are authentic; the default is 1 which should not be changed except for LAN environments where there is no Internet Access and you fully trust the Servers you are connecting to
Holds the period of time (milliseconds) that PunkBuster "sleeps" between processing cycles; the default is 60; lower numbers will cause PunkBuster to process events more times each second which also has the effect of increasing the bandwidth used by PunkBuster; Players with a modem connection will probably want to set this as high as possible
PB_SsLog [0=no, 1=yes]
When set to 1 (which is the default), PunkBuster will create an entry in the pbsslog.htm log file every time a PunkBuster Server requests a screenshot to be taken and delivered; this log file is designed to be viewed with a web browser and contains information about the size of the image, when it was taken, and also a digital signature of the image itself
PB_SsSave [0=no, 1=yes]
When set to 1 (0 is the default), PunkBuster will save all Server-requested Screenshots to the local hard drive so that Players can see the actual screenshots that have been delivered to Game Servers that they were connected to; if this setting and the PB_SsLog setting are both set to 1, then the pbsslog.htm log file will automatically have links created for local viewing directly from the log file
PB can conflict with other software on some systems due to vigorous memory scanning; Changing this setting may reduce or eliminate conflicts if you have problems on your system; this setting can only be changed before connecting to a server