PPF Home
Plugins
Developers
   Font size:      

Say (v1.1)

PDF
PDF

Description

This plugin allows you to speak via the bot.

The Say plugin lets you send messages or actions to a channel using the bot. You can also make an announcement to all channels that the bot is in (shout). It can, optionally, show who sent the message.

Configuration

The configuration file for this plugin is system/Say/SayConfig.xml

commandSay

The command for making the bot say something in a channel. You can set the authLevel to control who is allowed to access the command, and showSpeaker to control wether or not the messages are prefixed with the user that is using the bot to speak through.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • showSpeaker - YES, NO

		<commandSay authLevel="trusted" showSpeaker="yes">say</commandSay>

    

commandAction

The command for making the bot do an action in a channel. You can set the authLevel to control who is allowed to access the command, and showSpeaker to control wether or not the actions are suffixed with the user that is using the bot to speak through.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • showSpeaker - YES, NO

		<commandAction authLevel="trusted" showSpeaker="no">me</commandAction>

    

commandShout

The command for making the bot say something in all channels it is in. You can set the authLevel to control who is allowed to access the command, and showSpeaker to control wether or not the messages are prefixed with the user that is using the bot to speak through.

  • authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
  • showSpeaker - YES, NO

		<commandShout authLevel="trusted" showSpeaker="yes">shout</commandShout>

    

Old-style configuration options

These are a couple of wider options, kept for backwards-compatibility - they work as described(like in earlier versions), but are overridden if the new configuration options are used.

These options are deprecated, and may be removed in the future.

authLevel

The level a user has to be authed at to be able to use the Say features. Valid values are ANY, ADMIN, MASTER, TRUSTED, NONE.


    <authLevel>trusted</authLevel>

      

showSpeaker

If the user using the bot to speak through should be shown as a prefix to the message. Does not affect actions. Valid values are YES and NO.


    <showSpeaker>yes</showSpeaker>

      

Commands

Speak through the bot

Command: say
Description: This will make the bot say the message in the #channel you give
Auth Level: trusted
Where to give command: private message
Outputs to: channel
Example(s):

  • say #deaded hello, I am BotEd

Perform an action through the bot

Command: me
Description: This will make the bot show the action in the #channel you give
Auth Level: trusted
Where to give command: private message
Outputs to: channel
Example(s):

  • me #deaded does a little dance

Announce to all channels the bot is in

Command: shout
Description: This will make the bot say the message in all of the channels it is in
Auth Level: trusted
Where to give command: private message
Outputs to: channel
Example(s):

  • shout Restarting for an update...

Change History

v1.1 By EdorFaus: updated the configuration file to be more flexible(old style is still understood, but deprecated).
v1.0 First Version by DeadEd