Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 12:12:54 +01:00
Code Issues Projects Releases Wiki Activity

Aka, Alias: replace obsolete LastFM example

Browse Source
This commit is contained in:
James Lu 2022-07-09 14:15:57 -07:00
parent 988fe08945
commit 95f6b1698e
4 changed files with 38 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
plugins/Aka/README.rst
View File

@ -46,7 +46,7 @@ Now you can use Aka as you used Alias before.
Trout Trout
^^^^^ ^^^^^
Add an aka, trout, which expects a word as an argument:: Add an aka, ``trout``, which expects a word as an argument::
<jamessan> @aka add trout "reply action slaps $1 with a large trout" <jamessan> @aka add trout "reply action slaps $1 with a large trout"
<bot> jamessan: The operation succeeded. <bot> jamessan: The operation succeeded.
@ -56,23 +56,19 @@ Add an aka, trout, which expects a word as an argument::
This ``trout`` aka requires the plugin ``Reply`` to be loaded since it This ``trout`` aka requires the plugin ``Reply`` to be loaded since it
provides the ``action`` command. provides the ``action`` command.
LastFM Random percentage
^^^^^^ ^^^^^^^^^^^^^^^^^
Add an aka, ``lastfm``, which expects a last.fm username and replies with Add an aka, ``randpercent``, which returns a random percentage value::
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]]" @aka add randpercent "squish [dice 1d100]%"
This ``lastfm`` aka requires the following plugins to be loaded: ``RSS``, This requires the ``Filter`` and ``Games`` plugins to be loaded.
``Format`` and ``Web``.
``RSS`` provides ``rss``, ``Format`` provides ``concat`` and ``Web`` provides Note that nested commands in an alias should be quoted, or they will only
``urlquote``. run once when you create the alias, and not each time the alias is
called. (In this case, not quoting the nested command would mean that
Note that if the nested commands being aliased hadn't been quoted, then ``@randpercent`` always responds with the same value!)
those commands would have been run immediately, and ``@lastfm`` would always
reply with the same information, the result of those commands.
.. _commands-Aka: .. _commands-Aka:

24
plugins/Aka/plugin.py
View File

@ -532,7 +532,7 @@ class Aka(callbacks.Plugin):
Trout Trout
^^^^^ ^^^^^
Add an aka, trout, which expects a word as an argument:: Add an aka, ``trout``, which expects a word as an argument::
<jamessan> @aka add trout "reply action slaps $1 with a large trout" <jamessan> @aka add trout "reply action slaps $1 with a large trout"
<bot> jamessan: The operation succeeded. <bot> jamessan: The operation succeeded.
@ -542,23 +542,19 @@ class Aka(callbacks.Plugin):
This ``trout`` aka requires the plugin ``Reply`` to be loaded since it This ``trout`` aka requires the plugin ``Reply`` to be loaded since it
provides the ``action`` command. provides the ``action`` command.
LastFM Random percentage
^^^^^^ ^^^^^^^^^^^^^^^^^
Add an aka, ``lastfm``, which expects a last.fm username and replies with Add an aka, ``randpercent``, which returns a random percentage value::
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]]" @aka add randpercent "squish [dice 1d100]%"
This ``lastfm`` aka requires the following plugins to be loaded: ``RSS``, This requires the ``Filter`` and ``Games`` plugins to be loaded.
``Format`` and ``Web``.
``RSS`` provides ``rss``, ``Format`` provides ``concat`` and ``Web`` provides Note that nested commands in an alias should be quoted, or they will only
``urlquote``. run once when you create the alias, and not each time the alias is
called. (In this case, not quoting the nested command would mean that
Note that if the nested commands being aliased hadn't been quoted, then ``@randpercent`` always responds with the same value!)
those commands would have been run immediately, and ``@lastfm`` would always
reply with the same information, the result of those commands.
""" """
def __init__(self, irc): def __init__(self, irc):

16
plugins/Alias/README.rst
View File

@ -18,21 +18,23 @@ This plugin is only kept for backward compatibility, you should use the
built-in Aka plugin instead (you can migrate your existing aliases using built-in Aka plugin instead (you can migrate your existing aliases using
the 'importaliasdatabase' command. the 'importaliasdatabase' command.
To add an alias, `trout`, which expects a word as an argument:: To add an alias, ``trout``, which expects a word as an argument::
<jamessan> @alias add trout "action slaps $1 with a large trout" <jamessan> @alias add trout "action slaps $1 with a large trout"
<bot> jamessan: The operation succeeded. <bot> jamessan: The operation succeeded.
<jamessan> @trout me <jamessan> @trout me
* bot slaps me with a large trout * bot slaps me with a large trout
To add an alias, `lastfm`, which expects a last.fm user and replies with Add an alias, ``randpercent``, which returns a random percentage value::
their recently played items::
@alias add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [urlquote $1] /recenttracks.rss]]" @alias add randpercent "squish [dice 1d100]%"
Note that if the nested commands being aliased hadn't been quoted, then This requires the ``Filter`` and ``Games`` plugins to be loaded.
those commands would have been run immediately, and `@lastfm` would always
reply with the same information, the result of those commands. Note that nested commands in an alias should be quoted, or they will only
run once when you create the alias, and not each time the alias is
called. (In this case, not quoting the nested command would mean that
``@randpercent`` always responds with the same value!)
.. _commands-Alias: .. _commands-Alias:

16
plugins/Alias/plugin.py
View File

@ -243,21 +243,23 @@ class Alias(callbacks.Plugin):
built-in Aka plugin instead (you can migrate your existing aliases using built-in Aka plugin instead (you can migrate your existing aliases using
the 'importaliasdatabase' command. the 'importaliasdatabase' command.
To add an alias, `trout`, which expects a word as an argument:: To add an alias, ``trout``, which expects a word as an argument::
<jamessan> @alias add trout "action slaps $1 with a large trout" <jamessan> @alias add trout "action slaps $1 with a large trout"
<bot> jamessan: The operation succeeded. <bot> jamessan: The operation succeeded.
<jamessan> @trout me <jamessan> @trout me
* bot slaps me with a large trout * bot slaps me with a large trout
To add an alias, `lastfm`, which expects a last.fm user and replies with Add an alias, ``randpercent``, which returns a random percentage value::
their recently played items::
@alias add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [urlquote $1] /recenttracks.rss]]" @alias add randpercent "squish [dice 1d100]%"
Note that if the nested commands being aliased hadn't been quoted, then This requires the ``Filter`` and ``Games`` plugins to be loaded.
those commands would have been run immediately, and `@lastfm` would always
reply with the same information, the result of those commands. Note that nested commands in an alias should be quoted, or they will only
run once when you create the alias, and not each time the alias is
called. (In this case, not quoting the nested command would mean that
``@randpercent`` always responds with the same value!)
""" """
def __init__(self, irc): def __init__(self, irc):
self.__parent = super(Alias, self) self.__parent = super(Alias, self)