PPF Home
Plugins
Developers
   Font size:      

InfoBot (v1.1)

PDF
PDF

Description

Learns the definition of words, and displays these definitions when asked.

Configuration

The configuration file for this plugin is system/InfoBot/InfoBotConfig.xml

commandLearn

The command for learning the definition of a word.
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

        <commandLearn authLevel="trusted" output="channel">!learn</commandLearn>

      

commandWhat

The command for showing the definition(s) of a known word.
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

        <commandWhat authLevel="none" output="channel">!what</commandWhat>

      

commandListLearned

The command for showing which words are known, or which definitions are known for a given word, with their IDs (for removal).
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

        <commandListLearned authLevel="trusted" output="channel">!listlearned</commandListLearned>

      

commandUnLearn

The command for UNlearning (removing) a word, or one definition of a word.
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

        <commandUnLearn authLevel="trusted" output="channel">!unlearn</commandUnLearn>

      

Commands

!learn

Command: !learn
Description: This will teach the bot the definition of a word. If the word is already known with a different definition, then the given definition is added to the one already known - if it is the same definition as a known one, it is ignored.
Auth Level: trusted
Where to give command: channel, pm
Outputs to: same as given
Example(s):

  • !learn IRC Internet Relay Chat

!what

Command: !what
Description: This will show the definition(s) of a word.
Auth Level: none
Where to give command: channel, pm
Outputs to: same as given
Example(s):

  • !what IRC

!listlearned

Command: !listlearned
Description: This will show the known words, or the definitions of a word with IDs (used for removal).
Auth Level: trusted
Where to give command: channel, pm
Outputs to: same as given
Example(s):

  • !listlearned
  • !listlearned IRC

!unlearn

Command: !unlearn
Description: This will remove a word or one definition of a word (which one is given by ID as per !listlearned).
Auth Level: trusted
Where to give command: channel, pm
Outputs to: same as given
Example(s):

  • !unlearn IRC 1
  • !unlearn IRC

Change History

v1.1 Added i18n, with english and german languages (by Bananeweizen)
v1.0 First Version by EdorFaus