833af36b08
Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason.
1.3 KiB
Documentation for the Games plugin for Supybot
Purpose
This plugin provides some fun games like (Russian) roulette, 8ball, monologue which tells you how many lines you have spoken without anyone interrupting you, coin and dice.
Usage
This plugin provides some small games like (Russian) roulette, eightball, monologue, coin and dice.
Commands
- coin takes no arguments
-
Flips a coin and returns the result.
- dice <dice>d<sides>
-
Rolls a die with <sides> number of sides <dice> times. For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10 ten-sided dice.
- eightball [<question>]
-
Ask a question and the answer shall be provided.
- monologue [<channel>]
-
Returns the number of consecutive lines you've sent in <channel> without being interrupted by someone else (i.e. how long your current 'monologue' is). <channel> is only necessary if the message isn't sent in the channel itself.
- roulette [spin]
-
Fires the revolver. If the bullet was in the chamber, you're dead. Tell me to spin the chambers and I will.
Configuration
- supybot.plugins.Games.public
-
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.