Limnoria/plugins/Aka
2017-04-17 10:53:26 +02:00
..
local Aka: First commit. 2013-07-23 21:02:06 +02:00
locales Aka: add a missing '.' in the error message 2014-12-26 16:21:20 -05: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: Allow more than one in an aka. Closes GH-1283. 2017-04-17 10:53:26 +02:00
README.md Aka: use better quotes for lastfm in README.md. 2014-05-19 12:27:07 +03:00
test.py Aka: Allow more than one in an aka. Closes GH-1283. 2017-04-17 10:53:26 +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 providesconcatandWebprovidesurlquote`.

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.