mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-20 09:29:24 +01:00
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.
28 lines
785 B
ReStructuredText
28 lines
785 B
ReStructuredText
.. _plugin-Nickometer:
|
|
|
|
Documentation for the Nickometer plugin for Supybot
|
|
===================================================
|
|
|
|
Purpose
|
|
-------
|
|
A port of Infobot's nickometer command from Perl. This plugin
|
|
provides one command (called nickometer) which will tell you how 'lame'
|
|
an IRC nick is. It's an elitist hacker thing, but quite fun.
|
|
|
|
Usage
|
|
-----
|
|
Will tell you how lame a nick is by the command 'nickometer [nick]'.
|
|
|
|
Commands
|
|
--------
|
|
nickometer [<nick>]
|
|
Tells you how lame said nick is. If <nick> is not given, uses the nick of the person giving the command.
|
|
|
|
Configuration
|
|
-------------
|
|
supybot.plugins.Nickometer.public
|
|
This config variable defaults to "True", is not network-specific, and is not channel-specific.
|
|
|
|
Determines whether this plugin is publicly visible.
|
|
|