Phergie plugin for displaying a random fortune in channel.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.editorconfig
.gitattributes
.gitignore
.php_cs
.travis.yml
CHANGES.md
LICENSE.md
README.md
composer.json
composer.lock
phpcs.xml.dist
phpunit.xml.dist

README.md

sitedyno/phergie-fortune

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.

Build Status codecov

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.