Limnoria

mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-30 06:49:24 +01:00

History

Valentin Lorentz 4fcf4d426d Aka: Add a README (based on Alias').		2013-08-02 15:33:45 +02:00
..
local	Aka: First commit.	2013-07-23 21:02:06 +02:00
__init__.py	Aka: First commit.	2013-07-23 21:02:06 +02:00
config.py	Aka: First commit.	2013-07-23 21:02:06 +02:00
messages.pot	Aka: Add messages.pot.	2013-07-31 19:09:29 +02:00
plugin.py	Aka: Fix listCommands, which returned tuples instead of strings.	2013-08-01 10:44:19 +02:00
README.txt	Aka: Add a README (based on Alias').	2013-08-02 15:33:45 +02:00
test.py	Aka: Fix conflict of test cases of they are run after Alias' tests.	2013-08-01 12:07:19 +02:00

README.txt

This plugin allows the user to create various aliases (known as "Akas",
since Alias is the name of another plugin Aka is based on) to other commands
or combinations of other commands (via nested commands).  It is a good
idea to always quote the commands that are being aliased so that any
nested commands are not immediately run.

Basic usage
-----------

Add an aka, trout, which expects a word as an argument

<jamessan> @aka add trout "action slaps $1 with a large trout"
<bot> jamessan: The operation succeeded.
<jamessan> @trout me
* bot slaps me with a large trout

Add an aka, lastfm, which expects a last.fm user and replies with
their recently played items.

@alias add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [urlquote $1] /recenttracks.rss]]"

Note that if the nested commands being aliased hadn't been quoted, then
those commands would have been run immediately, and @lastfm would always
reply with the same information, the result of those commands.
 with any notes, etc. about using it.