Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Limnoria/plugins/Utilities
History
Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices 
This commit reverts db7ef3f025
(though it keeps the year updates)

After discussion with several people, it seems better to mention
copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright
explains the issue of using VCSs to track copyright.

As db7ef3f025 only replaced mentions
of my name with 'The Limnoria Contributors', this commit only needs
to undo that + add one person who contributed to setup.py.
 		2021-10-17 09:57:55 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
__init__.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
config.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
test.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00

README.rst

Documentation for the Utilities plugin for Supybot

Purpose

Various utility commands, mostly useful for manipulating nested commands.

Usage

Provides useful commands for bot scripting / command nesting.

Commands

apply <command> <text>

Tokenizes <text> and calls <command> with the resulting arguments.

countargs <arg> [<arg> ...]

Counts the arguments given.

echo <text>

Returns the arguments given it. Uses our standard substitute on the string(s) given to it; $nick (or $who), $randomNick, $randomInt, $botnick, $channel, $user, $host, $today, $now, and $randomDate are all handled appropriately.

ignore requires no arguments

Does nothing. Useful sometimes for sequencing commands when you don't care about their non-error return values.

last <text> [<text> ...]

Returns the last argument given. Useful when you'd like multiple nested commands to run, but only the output of the last one to be returned.

let <variable> = <value> in <command>

Defines <variable> to be equal to <value> in the <command> and runs the <command>. '=' and 'in' can be omitted.

sample <num> <arg> [<arg> ...]

Randomly chooses <num> items out of the arguments given.

shuffle <arg> [<arg> ...]

Shuffles the arguments given.

sort <arg> [<arg> ...]

Sorts the arguments given.

success [<text>]

Does nothing except to reply with a success message. This is useful when you want to run multiple commands as nested commands, and don't care about their output as long as they're successful. An error, of course, will break out of this command. <text>, if given, will be appended to the end of the success message.

Configuration

supybot.plugins.Utilities.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.