summaryrefslogtreecommitdiff
path: root/plugins/figlet.py
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/figlet.py')
-rw-r--r--plugins/figlet.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/figlet.py b/plugins/figlet.py
index eaf8dab3..9006f793 100644
--- a/plugins/figlet.py
+++ b/plugins/figlet.py
@@ -1,3 +1,23 @@
+"""
+This plugin uses figlet to transform every message into a big ascii-art
+message.
+
+Installation
+------------
+You only have to load the plugin (and have :file:`figlet` installed, of course).
+::
+
+ /load figlet
+
+
+Usage
+-----
+
+Say something in a Chat tab.
+
+.. note:: Can create fun things when used with :ref:`The rainbow plugin <rainbow-plugin>`.
+
+"""
from plugin import BasePlugin
import subprocess