sitedyno/phergie-fortune

Phergie plugin for displaying a fortune in channel

1.0 2017-05-07 19:47 UTC

Requires

• phergie/phergie-irc-bot-react: ~2
• phergie/phergie-irc-plugin-react-command: ~2.0
• react/child-process: ^0.4.3

Requires (Dev)

• phake/phake: ^2.3
• phpunit/phpunit: 4.5.*
• squizlabs/php_codesniffer: ^2.8

Suggests

• phergie/phergie-irc-plugin-react-commandhelp: provides interactive help for commands

MIT

• Heath Nail

• plugin
• bot
• irc
• phergie

README

Phergie plugin for displaying a fortune in channel.

⚠️ This plugin makes system calls! It should be fine unless misconfigured. You have been warned. ⚠️

This plugin assumes you have installed fortune on your *nix like system. For more detailed information on databases see man fortune.

Install

The recommended method of installation is through composer.

composer require sitedyno/phergie-fortune

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

Provided Commands

Command	Parameters	Description
!fortune	none	Displays a random fortune in channel

Configuration

return [
    'plugins' => [
        // dependency
        new \Phergie\Irc\Plugin\React\Command\Plugin,

        // configuration, all is optional
        new \Sitedyno\PhergieFortune\Plugin([
            // The path to the fortune binary. Defaults to '/usr/games/fortune'.
            'binary-path' => '/usr/games/fortune',
            // List of databases to use. Defaults to 'fortunes'. See `man fortune` for possible values.
            'databases' => 'fortune',
            // Use only short fortunes. Defaults to true.
            'short' => true
        ])
    ]
];

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 MIT License. See LICENSE.md.