PPF Home
Plugins
Developers
   Font size:      

BF Tracks (v1.0)

PDF
PDF

Description

The BF Tracks plugin searches through bftracks and displays player info to IRC.

This plugin allows you to retreive player information from http://www.bftracks.net and http://vietnam.bftracks.net. You can get ranking information or live player information. There is also an longer search useful for clan listings.

Configuration

The configuration file for this plugin is system/BFTracks/BFTracksConfig.xml

commandBF

The command to get a player ranking for BF. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBF authLevel="none" output="channel">!bf</commandBF>

    

commandBFLive

The command to get live player information for BF. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBFLive authLevel="none" output="channel">!bflive</commandBFLive>

    

commandBFClanList

The command to get a clan listing for BF. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBFClanList authLevel="none" output="pm">!bfclanlist</commandBFClanList>

    

commandBFV

The command to get a player ranking for BFV. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBFV authLevel="none" output="channel">!bfv</commandBFV>

    

commandBFVLive

The command to get live player information for BFV. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBFVLive authLevel="none" output="channel">!bfvlive</commandBFVLive>

    

commandBFVClanList

The command to get a clan listing for BFV. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBFVClanList authLevel="none" output="pm">!bfvclanlist</commandBFVClanList>

    

commandBFAllLive

The command to get live player information for both BF and BFV. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • output - CHANNEL, PM, NOTICE

      <commandBFAllLive authLevel="none" output="pm">!alllive</commandBFAllLive>

    

maxResults

Sets how many lines to return for the different query types.

  • playerInfo - player ranking result length
  • liveInfo - live player information result length
  • clanListInfo - clan listing result length

    <maxResults playerInfo="3" liveInfo="5" clanListInfo="30"/>

    

playerInfo

How the output for the player and clanlist ranking will appear. The colours and formatting are explained in the Output Formatting page.

  • $name - the name of the player
  • $ranking - their ranking position
  • $points - their points in the system
  • $url - url to their page in the system

    <playerInfo>$DARK_GREEN$name$NORMAL :: [$BOLD$BLUE$ranking$NORMAL]($DARK_GREEN$points$NORMAL points) :: $UNDERLINE$OLIVE$url</playerInfo>

    

liveInfo

How the output for the live info will appear. The colours and formatting are explained in the Output Formatting page.

  • $name - the name of the player
  • $score - current score
  • $kills - current kills
  • $deaths - current deaths
  • $server - name of the server
  • $ip - ip of the server
  • $map - current map

    <liveInfo>$DARK_GREEN$name$NORMAL[$BLUE$BOLD$score$NORMAL/$DARK_GREEN$kills$NORMAL/$RED$deaths$NORMAL] :: 
        $OLIVEServer: $BOLD$server$NORMAL IP: $REVERSE$ip$NORMAL:: $DARK_GRAYMap: $UNDERLINE$map</liveInfo>

    

Commands

Show BF player stats

Command: !bf
Description: Shows the player stats from bftracks.net
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

  • !bf deaded

Show live BF player information

Command: !bflive
Description: Shows the players that are online according to the bftracks.net system
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

  • !bflive deaded

Show BF clan stats

Command: !bfclanlist
Description: Shows a longer list of player stats from bftracks.net - best used with a clan tag
Auth Level: none
Where to give command: channel
Outputs to: pm
Example(s):

  • !bfclanlist [KsR]
  • !bfclanlist [LK]

Show BFV player stats

Command: !bfv
Description: Shows the player stats from vietnam.bftracks.net
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

  • !bfv deaded

Show live BFV player information

Command: !bfvlive
Description: Shows the players that are online according to the vietnam.bftracks.net system
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

  • !bfvlive deaded

Show BFV clan stats

Command: !bfvclanlist
Description: Shows a longer list of player stats from vietnam.bftracks.net - best used with a clan tag
Auth Level: none
Where to give command: channel
Outputs to: pm
Example(s):

  • !bfvclanlist [KsR]
  • !bfvclanlist [LK]

Show live BF and BFV player information

Command: !alllive
Description: Shows the players that are online according to the bftracks.net AND vietnam.bftracks.net system
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

  • !alllive deaded

Change History

v1.0 First Version by DeadEd