Phergie plugin for enabling the use of custom aliases for existing bot commands
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
.gitignore
.travis.yml
LICENSE
README.md
composer.json
composer.lock
phpunit.xml

README.md

phergie/phergie-irc-plugin-react-commandalias

Phergie plugin for enabling the use of custom aliases for existing bot commands.

This plugin is intended to complement the Command plugin.

Build Status

Install

The recommended method of installation is through composer.

{
    "require": {
        "phergie/phergie-irc-plugin-react-commandalias": "dev-master"
    }
}

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

Configuration

new \Phergie\Irc\Plugin\React\CommandAlias\Plugin(array(

    // All configuration is required

    'aliases' => array(
        // alias => command
        'j' => 'join',
        'p' => 'part',
        'q' => 'quit',
        'btc' => 'wolfram-alpha 1 BTC in US$',
        // ...
    ),

))

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.