Karma Plugin for Phergie
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
.gitattributes
.gitignore
.php_cs
.travis.yml
CHANGES.md
LICENSE.md
README.md
composer.json
composer.lock
phpunit.xml

README.md

pschwisow/phergie-irc-plugin-react-karma

Phergie plugin for handling requests to increment or decrement counters on specified terms.

Build Status Code Climate Test Coverage

Install

The recommended method of installation is through composer.

php composer.phar require pschwisow/phergie-irc-plugin-react-karma

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

Provided Commands

The karma plugin maintains karma values for a list of terms and compares them as requested. Terms are most often IRC nicks, but the plugin does not require this. Terms may optionally be enclosed in parentheses (most often used for terms that contain whitespace).

Command Description
!karma term Get the current karma value for a term
!reincarnate term Reset the karma value for a term
term++ Increment the karma value for a term
term-- Decrement the karma value for a term
term1 < term2 Compare karma values of two terms
term1 > term2 Compare karma values of two terms

Configuration

return [
    'plugins' => [
        // configuration
        new \PSchwisow\Phergie\Plugin\Karma\Plugin([



        ])
    ]
];

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.