falso
/
oddluck-limnoria-plugins
mirror of https://github.com/oddluck/limnoria-plugins.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updates README.md

This commit is contained in:
Matthias Meusburger 2012-08-24 08:40:50 +02:00
parent 72cec63dea
commit f4bf109566
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,7 +1,25 @@
\_o< ~ DuckHunt game for supybot ~ >o_/
=======================================
A DuckHunt game for supybot. Use the "start" command to start a game.
The bot will randomly launch ducks. Whenever a duck is launched, the first
person to use the "bang" command wins a point. Using the "bang" command
when there is no duck launched costs a point.
How to play
-----------
Use the "start" command to start a game.
The bot will randomly launch ducks. Whenever a duck is launched, the first person to use the "bang" command wins a point.
Using the "bang" command when there is no duck launched costs a point.
If a player shoots all the ducks during a hunt, it's a perfect! This player gets extra bonus points.
The best scores for a channel are recorded and can be displayed with the "listscores" command.
The quickest and longest shoots are also recorded and can be displayed with the "listtimes" command.
The "launched" command tells if there is currently a duck to shoot.
How to install
--------------
Just place the DuckHunt plugin in the plugins directory of your supybot installation and load the module.
How to configure
----------------
Several per-channel configuration variables are available (look at the "channel" command to learn more on how to configure per-channel configuration variables):
* autoRestart: Does a new hunt automatically start when the previous one is over?
* ducks: Number of ducks during a hunt?
* frequency: Determines how often a duck will be launched. 0 means that no duck will ever be launched. 1 means that a ducks will be launched one after another.
* minthrottle: The minimum amount of time before a new duck may be launched (in seconds)
* maxthrottle: The maximum amount of time before a new duck may be launched (in seconds)