mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-11-23 11:09:23 +01:00
Aka: Add a README (based on Alias').
This commit is contained in:
parent
7f562e15c9
commit
4fcf4d426d
@ -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.
|
||||||
|
Loading…
Reference in New Issue
Block a user