phergie/phergie-irc-plugin-react-magic-eight-ball

Phergie plugin for Helping users make decisions

2.0.0 2015-12-22 07:59 UTC

Requires

• phergie/phergie-irc-bot-react: ~2

Requires (Dev)

• codeclimate/php-test-reporter: 0.1.*@dev
• phake/phake: 1.0.*
• phpunit/phpunit: 4.1.*
• satooshi/php-coveralls: v0.6.1

BSD-2-Clause

• plugin
• bot
• irc
• phergie

README

Phergie plugin for Helping users make decisions.

Install

The recommended method of installation is through composer.

{
    "require": {
        "phergie/phergie-irc-plugin-react-magic-eight-ball": "~2"
    }
}

See Phergie documentation for more information on installing and enabling plugins.

Configuration

The Magic Eightball plugin requires a response provider with the AnswerProvider interface. The EightballProvider comes with the plugin but you can provide your own class if you want to provide different answers.

new \Phergie\Irc\Plugin\React\MagicEightBall\Plugin()

By default, the Plugin will provide \Phergie\Irc\Plugin\React\MagicEightBall\EightballProvider() if you do not specify a provider. You can also create your own provider and send it into the plugin to get different responses.

new \Phergie\Irc\Plugin\React\MagicEightBall\Plugin(
    new \Phergie\Irc\Plugin\React\MagicEightBall\EightballProvider() // Replace with your own provider
)

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.