Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 12:12:54 +01:00
Code Issues Projects Releases Wiki Activity
833af36b08
Limnoria/plugins/Games
History
Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs 
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.
2021-04-05 17:42:31 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py all plugins: Use msg.channel instead of msg.args[0] + give network name to self.registryValue. 2019-08-24 23:35:01 +02:00
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py Replace failUnless/failIf with assertTrue/assertFalse. 2020-01-26 11:14:18 +01:00

README.rst

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.