PPF Home
Plugins
Developers
   Font size:      

CB Finder (v1.1)

PDF
PDF

Description

This plugin allows you to retreive clan information from ClanBase. The CB Finder plugin searches through http://www.clanbase.com and displays relevant information about the clan to IRC.

The ClanBase clan finder helps you find information about clans. You enter either the tag, name of a clan, or even a partial name if that is all you know, and in extreme cases (or if you have an exceptional memory) you can enter the clans CB ID. If your search returns more than 20 hits, you will be notified and asked to refine the search keyword(s). If there were less than 20 hits, but more than 1, an exact match will try to be found and displayed. At the same time, you will be shown all of the other clan names that contained what you were looking for, along with the CB ID. You can then enter the full name, or if there is more than one clan with the same full name, you can enter the CB ID of the clan you want to have a look at. Of course, if there was only a single result, you will be shown details of that clan only.

You will be shown details about the clan, and each ladder that they are in, plus (if available) the last 5 matches from each ladder.

Configuration

The configuration file for this plugin is system/CBFinder/CBFinderConfig.xml

commandCB

The command for requesting CB info. 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

      <commandCB authLevel="master" output="channel">!cb</commandCB>

    

commandCBDCC

The command for requesting CB info using DCC chat, which makes it much faster for the bot to display all of the info. You can set the authLevel to control who is allowed to access the command.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE

      <commandCBDCC authLevel="none">!cbdcc</commandCBDCC>

    

cbID

A default CB ID to use


        <cbID>75433</cbID>

    

cbGameType


        <cbGameType>BF</cbGameType>

    

Commands

Search for a clan

Command: !cb clan
Description: This will search clanbase for the clan you have given
Auth Level: none
Where to give command: channel
Outputs to: private message
Example(s):

  • !cb KsR
  • !cb grave guardians

Search for a clan - results returned via DCC chat

Command: !cbdcc clan
Description: This will search clanbase for the clan you have given
Auth Level: none
Where to give command: channel
Outputs to: DCC chat
Example(s):

  • !cbdcc KsR
  • !cbdcc grave guardians

Change History

v1.1 Updated for new layout by DeadEd
v1.0 First Version by DeadEd