Plug-ins

2008-08-27T01:23:15Z

Slon02:

BZFS can be built to support the loading of external libraries as plug-ins. These plug-ins can alter or replace the logic applied by the server, as well as automate many common tasks.

Plug-ins are a simpler way to apply modifications to the game, as they do not require the server owner to modify or recompile his/her BZFS application. By using the [[BZFS API]] plug-ins are also able to be mixed and matched in an easy way.

==Overview==
Plug-ins are compile dynamic link libraries, that are built for the same OS/RuntimeEnvironment as the BZFS server that hosts them. On [http://www.microsoft.com/windows Microsoft Windows] they are built as [http://en.wikipedia.org/wiki/Dynamic-link_library DLL] files. On [http://www.linux.org Linux] and other [http://www.unix.org/ Unix]-like systems they are built as .so files.

==Use==
Plug-ins are loaded at startup by the '''-loadplugin''' option, or at run time with the ''/loadplugin'' command. If the full path to the plug-in is not specified, then [[BZFS]] will search a number of known sub directories for the plug-in as it attempts to load it. Using a valid path to the plug-in on load is highly recommended. While playing, all plug-ins loaded onto the server are visible with the /listplugins command.
===Parameters===
Some plug-ins take parameters that are passed to the plug-in on load. This is often a numeric value, or a path to a file. To pass a parameter to a plug-in, simply add a ',' after the plug-in name or path, and then add the parameter. Parameters can not have spaces, due to the way [[BZFS]] parses command line options and / commands.

On load, plug-ins install a number of callbacks and event handlers with the hosting [[BZFS]] that are called when specific events happen. This allows the plug-in to perform additional actions on these events, or if need be, alter the results of the default logic of the server.
===Search Paths===
[[BZFS]] searches for plug-ins in two standard locations: the config directory and the global plug-ins directory. The config directory is where the BZFlag config.cfg file is located, and the global plug-ins directory is $(prefix)/lib/bzflag/.

==BZFS API==
All plug-ins are linked to the [[BZFS API]]. This programing layer provides the interface to the BZFS application. All events and functions that a plug-in can call are in the [[BZFS API]].

==Standard plug-ins==
The [[BZFlag Source]] distribution contains a number of plug-ins that are maintained by the project [http://my.bzflag.org/wiki/index.php/Category:Developer developers].
These plug-ins are located in the ''/plugins'' directory.

As of February 18th 2007, [[BZFlag SVN|SVN]] TRUNK( version [[BZFlag 3.0|2.99]]) contains the following plug-ins:

*[[airspawn]]
*[[bzfscron]]
*[[chathistory]]
*[[flagStay]]
*[[hiddenAdmin]]
*[[HoldTheFlag]]
*[[keepaway]]
*[[killall]]
*[[koth]]
*[[logDetail]]
*[[nagware]]
*[[playHistoryTracker]]
*[[Phoenix]]
*[[python(plug-in)|python]]
*[[recordmatch]]
*[[RogueGenocide]]
*[[SAMPLE_PLUGIN]]
*[[serverSideBotSample]]
*[[shockwaveDeath]]
*[[soundTest]]
*[[teamflagreset]]
*[[thiefControl]]
*[[timedctf]]
*[[torBlock]]
*[[weaponArena]]
*[[wwzones]]

==Third Party Plug-ins==
A number of non-developers have created plug-ins for BZFS, and usually release them on the [http://my.bzflag.org/bb/ BZFlag Forums].

==Plug-in Development==
{{DoDoc|Describe the basics of plug-in development.}}

[[Category:Server]]
[[Category:Development]]
[[Category:Plug-Ins]]

Slash Commands

2008-08-27T01:13:59Z

Slon02:

Below is a list of the commands that are available in BZFlag. Access to most of these commands is controlled through [[Server_Permissions|permissions]].

All commands are preceded by a '/' on any chat prompt.
The format for commands that take arguments are provided by the server by issuing the command with no arguments. (ie. `/ban`)

'''Some commands take no arguments''' (eg. ''/shutdownserver'', ''/superkill'') '''and therefore''' do not return the format string for the command but '''execute the command instead.'''

{|{{Prettytable}}
|-
| {{Hl3}} |'''Command'''
| {{Hl3}} |'''Description'''
|-
| ''/?'' || List commands
|-
| ''/ban'' || Ban players using the specified IPs of the player specified for certain length of time from using this server.
|-
| ''/banlist'' || List all of the IPs currently banned from this server. Items from the master ban list on my.bzflag.org/bb have an '(m)' after the IP for masterban. If an argument is specified only bans that match the argument are displayed.
|-
| ''/checkip'' || Check if a specified IP is banned or not and report the results.
|-
| ''/clientquery'' || Retrieve client version info from all users, or just CALLSIGN if given
|-
| ''/countdown'' || Starts the countdown sequence for a timed game. The countdown sequence length can optionally be specified in seconds.
|-
| ''/date'' || Responds with the current server local date and time (same as /time).
|-
| ''/deregister'' || With an argument, it deregisters another user's callsign . Without, it removes your own registration. (only affects local registration)
|-
| ''/diff'' || Shows the ''/set'' server variables that are set to something other than the default (or at least most of them)
|-
| ''/endgame'' || Ends the current game
|-
| ''/flag reset'' || Repositions flags. If unused is specified, flags carried by tanks are not affected.
|-
| ''/flag up'' || Removes all flags from the game
|-
| ''/flag show'' || Shows all flags with information.
|-
| ''/flag give'' || Give the specified flag to the specified player. If the flag is not available, it will take a flag from the person who has the flag specified. You cannot give flags that do not exist on the map.
|-
| ''/flag take'' || Will take the flag that the player specified is currently carrying.
|-
| ''/flaghistory'' || Lists what flags players have grabbed in the past.
|-
| ''/gameover'' || Ends a timed game.
|-
| ''/ghost'' || Kicks off an impersonating player or ghost
|-
| ''/grouplist'' || Lists the available user groups
|-
| ''/groupperms'' || Lists the permissions for each group
|-
| ''/help'' || With no argument it displays a lists the help files available. With the argument it displays the contents of the help file.
|-
| ''/highlight'' || Highlights any text that contains the word or words specified in the argument to this command. For example, if you type /highlight genocide , then any text that is printed on the console that contains the word genocide will be underlined and in blue.
|-
| ''/hostban'' || Ban players using the specified hostnames for a certain length of time from using this server.
|-
| ''/hostbanlist'' || List all of the host patterns currently banned from this server.
|-
| ''/hostunban'' || Will remove the the specified host from the ban list so that players from that host will be able to blay again.
|-
| ''/idban'' || Ban a player by bzbb id. This will stick even if the player ip changes.
|-
| ''/idbanlist'' || List all bans made with ''/idban''
|-
| ''/identify'' || Log in to a registered callsign
|-
| ''/idlestats'' || Displays the idle time in seconds for each player. A player is idle when he is dead and has not respawned yet.
|-
| ''/idlist'' || Will list the currently banned IDs
|-
| ''/idunban'' || Will remove the ban on the ID specified so that the player may play on the server again.
|-
| ''/kick'' || Kick a named player off the server.
|-
| ''/kill'' || Kill a player (they explode). The kill shows up as coming from the server (IE the player sees "PLAYERNAME: destroyed by the server" in their console). The player killed loses a point, but the player running the /kill command does not gain a point.
|-
| ''/lagdrop'' || With no argument it displays current lagdrop setting, with argument it sets it to the value specified. This specifies the number of warnings a player gets due to high lag before the server kicks the players.
|-
| ''/lagstats'' || Lists network delays, jitter and number of lost (out of order packets) by player.
|-
| ''/lagwarn'' || With no argument it displays current lagwarn setting, with argument it sets it to the value specified. If a players lag is higher that the setting they will be warned, then kicked.
|-
| ''/listplugins'' || Displays the plug-ins loaded on the server.
|-
| ''/localset'' || Set local client variables in your configuration file.
|-
| ''/masterban'' || Manipulate the master ban list.
|-
| ''/me'' || This command displays an "action" that is conveyed to another player. It allows for a little more expressivity in the game. For example if your callsign was 'Thumper': "/me is hunting wabbits" turns into a message like "Thumper is hunting wabbits" that gets displayed differently to other players than regular chat.
|-
| ''/msg'' || This command allows a player to send a message to another player. Similar to using the "," and "." message keys in the game and then selecting your recipient, this will send some message to particular player.
|-
| ''/mute'' || Allows a server admin to remove the ability for a player to communicate with other players. Once muted the player may only talk to admins on the server. This command removes the TALK permission for that user.
|-
| ''/part'' || Leave the server with a goodbye message (same as /quit).
|-
| ''/password'' || Enter server password to gain operator privileges. It is frowned upon to use this command on servers where you are not an admin
|-
| ''/playerlist'' || List player names and IP addresses.
|-
| ''/poll'' || Start a player poll
|-
| ''/quit'' || Leave the server with a goodbye message (same as /part).
|-
| ''/record'' || List all files in the recordings directory
|-
| ''/record start'' || Starts recording
|-
| ''/record stop'' || Stops recording
|-
| ''/record size'' || Specify size of recording buffer in megabytes (MB)
|-
| ''/record rate'' || Specify recording rate in seconds
|-
| ''/record stats'' || Display statistics of recording
|-
| ''/record file'' || Specify a filename for recording instead of using memory
|-
| ''/record save'' || Save an in-memory recording buffer to a file
|-
| ''/register'' || Register your current callsign locally to the specified password. Passwords must be at least 3 characters long, and the callsign may not contain quotes or other non-alphanumeric/space characters. We use global logons and this is not needed.
|-
| ''/reload'' || Reloads the user, group, and password files (for synchronization between multiple servers on the same machine)
|-
| ''/removegroup'' || Remove a user from a group
|-
| ''/replay list'' || List recording files that can be replayed
|-
| ''/replay load'' || Load a recording file for play
|-
| ''/replay play'' || Start playback of the loaded recording
|-
| ''/replay skip'' || Skip forwards or backwards through the recording
|-
| ''/report'' || Write a message to the server administrator
|-
| ''/reset'' || Reset a server variable to it's [[BZFS|bzfs]] default setting.
|-
| ''/say'' || Generate a public message sent by the server. For example if your callsign were 'Tanner' using "/say This is a server message", will display ''[SERVER:] This is a server message (Tanner)''
|-
| ''/savemsgs'' || Saves the chat console to ''config directory''/msglog.txt. Use "/savemsgs -s" to strip coloring data.
|-
| ''/saveworld'' || Saves current world the client is paying on. For example, "/saveworld mapname.bzw" would save the world as "mapname.bzw".
|-
| ''/sendhelp'' || Send a help file to a player
|-
| ''/serverquery'' || Report the server version number
|-
| ''/set'' || With no arguments it will list the values of all server variables. With the arguments it will set the variable that is specified to the value that is given.
|-
| ''/setgroup'' || Add a user to a group
|-
| ''/setpass'' || Changes your password (for locally registered users, not globally)
|-
| ''/showgroup'' || Lists the groups that a registered user is a member of
|-
| ''/showperms'' || Show permissions granted to yourself or another player
|-
| ''/shutdownserver'' || Stop serving BZFlag on this server.
|-
| ''/superkill'' || Kick all players off the server.
|-
| ''/time'' || Responds with the current server local date and time (same as /date).
|-
| ''/unban'' || Will remove the IP address from the banlist, allowing someone from that address to connect and play BZFlag.
|-
| ''/unmute'' || Allows a server admin to restore the TALK permission to a previously muted player.
|-
| ''/uptime'' || Prints server's current running time in days, hours, minutes and seconds.
|-
| ''/veto'' || If there is a poll active, this will cancel the poll.
|-
| ''/viewreports'' || View the server's report file.
|-
| ''/vote'' || If there is a poll active, this command will place a vote in favor or in opposition to the poll. Multiple languages are supported as a vote argument in addition to "yes" and "no". By default, you must be registered to vote on a poll.
|}

[[Category:Server]]
[[Category:Client]]

BZFlagWiki - User contributions [en]

Plug-ins

Slash Commands