Note: As of v1.2.0 the config changed to use symbols for the channel names, please be aware.
Cinch::Cooldown
This library is used to add a global cooldown so that users are prevented from spamming the channel.
Installation
Add this line to your application's Gemfile:
gem 'cinch-cooldown'
And then execute:
$ bundle
Or install it yourself as:
$ gem install cinch-cooldown
Usage
Configuration Steps:
-
You need to add the configuration to your bot in the config block. You will need to add config info for every channel the bot is in that you want a cooldown. The
:global
is how many seconds the bot will wait before listening to a command that prints something to the channel, while the:user
directive is how long it will wait per user. Currently the gem is simple and assumes that the user timer will be greater than the global timer.c.shared[:cooldown] = { :config => { bottest: { global: 10, user: 20 } } }
-
If you are using this with my plugins, things should just work. However if you want to use this with your own plugins, you need to add a
'require cinch/cooldown'
to the top of said plugin, and anenforce_cooldown
to the plugin after theinclude Cinch::Plugin
line.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request