Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2025-10-31 23:57:22 +01:00
Code Issues Projects Releases Wiki Activity

Aka: Add a README (based on Alias').

Browse Source
This commit is contained in:
Valentin Lorentz 2013-08-02 15:33:20 +02:00
parent 7f562e15c9
commit 4fcf4d426d
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
plugins/Aka/README.txt
View File

@ -1 +1,25 @@
Insert a description of your plugin here, with any notes, etc. about using it.
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.