Limnoria/plugins/Aka
Valentin Lorentz bee98f6711 Conditional: Do not use noReply() after running the command.
As the command already calls reply() or noReply(), calling noReply()
there had disastrous effects:

* if reply() was called, noReply() erases the argument
* if noReply() was called, calling noReply() a second time erases **the next argument** (because the current argument was already erased).

This was 'caused' by the change of behavior of noReply() in 543edccd41.
2017-10-26 09:55:52 +02:00
..
local Aka: First commit. 2013-07-23 21:02:06 +02:00
locales Use a prefix-less help string, don't assume a '@' prefix (#1309) 2017-10-25 21:19:37 +02:00
__init__.py Remove trailing spaces. 2016-01-27 14:04:58 +01:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py Aka: Escape the command in help strings, so they can be copy-pasted into @aka add. 2017-10-01 10:40:23 +02:00
README.md Aka: fix backquote matching in readme 2017-05-04 14:58:48 +02:00
test.py Conditional: Do not use noReply() after running the command. 2017-10-26 09:55:52 +02:00

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

Alias

Add an aka, Alias, which eases the transitioning to Aka from Alias.

First we will load Alias and Aka.

<jamessan> @load Alias
<bot> jamessan: The operation succeeded.
<jamessan> @load Aka
<bot> jamessan: The operation succeeded.

Then we import the Alias database to Aka in case it exists and unload Alias.

<jamessan> @importaliasdatabase
<bot> jamessan: The operation succeeded.
<jamessan> @unload Alias
<bot> jamessan: The operation succeeded.

And now we will finally add the Aka alias itself.

<jamessan> @aka add "alias" "aka $1 $*"
<bot> jamessan: The operation succeeded.

Now you can use Aka as you used Alias before.

Trout

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

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

This trout aka requires the plugin Reply to be loaded since it provides the action command.

LastFM

Add an aka, lastfm, which expects a last.fm username and replies with their most recently played item.

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

This lastfm aka requires the following plugins to be loaded: RSS, Format and Web.

RSS provides rss, Format provides concat and Web provides urlquote.

Note that if the nested commands being aliased hadnt been quoted, then those commands would have been run immediately, and @lastfm would always reply with the same information, the result of those commands.