pschwisow / phergie-irc-plugin-react-puppet
Phergie plugin that allows a user to effectively speak and act as the bot.
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
- phake/phake: 2.0.0-beta2
- phpunit/phpunit: 4.1.*
- psr/log: 1.0.0
Suggests
- phergie/phergie-irc-plugin-react-commandhelp: provides interactive help for commands
This package is auto-updated.
Last update: 2024-10-19 09:19:29 UTC
README
Phergie plugin that allows a user to effectively speak and act as the bot.
Install
The recommended method of installation is through composer. The command help plug-in is not required, but is recommended (omit it if choose to).
{ "require": { "phergie/phergie-irc-plugin-react-commandhelp": "^2", "pschwisow/phergie-irc-plugin-react-puppet": "^2" } }
See Phergie documentation for more information on installing and enabling plugins.
Configuration
There is no plug-in specific configuration. The command plug-in is a hard dependency. If you include command help as recommend in the install section, you should also include it here.
return array( 'plugins' => [ // dependencies new \Phergie\Irc\Plugin\React\Command\Plugin, new \Phergie\Irc\Plugin\React\CommandHelp\Plugin, // optional / recommended new \PSchwisow\Phergie\Plugin\Puppet\Plugin, ] );
Usage
You can direct the bot either in a channel or by private message.
Private Message Window:
PSchwisow: say #phergie I am a bot.
PSchwisow: act #phergie acts like a bot.
PSchwisow: notice #phergie I like bots.
PSchwisow: help say
Phergie: Usage: puppet saying something
Phergie: Instructs the bot to repeat the specified phrase.
Channel #phergie:
Phergie: I am a bot.
- Phergie acts like a bot.
*Phergie* I like bots.
Tests
To run the unit test suite:
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit
License
Released under the BSD License. See LICENSE
.