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

Misc: add ability to specify custom help URLs when 'help' is ran without arguments

Browse Source
This commit is contained in:
James Lu 2014-12-05 19:05:01 -08:00
parent 654df6fac7
commit f5bf5129a9
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
plugins/Misc/config.py
View File

@ -49,6 +49,9 @@ conf.registerGlobalValue(Misc, 'listPrivatePlugins',
plugins with the list command if given the --private switch. If this is
disabled, non-owner users should be unable to see what private plugins
are loaded.""")))
conf.registerGlobalValue(Misc, 'customHelpString',
registry.String('', _("""Sets a custom help string, displayed when the 'help'
command is called without arguments.""")))
conf.registerGlobalValue(Misc, 'listUnloadedPlugins',
registry.Boolean(False, _("""Determines whether the bot will list unloaded
plugins with the list command if given the --unloaded switch. If this is

15
plugins/Misc/plugin.py
View File

@ -47,6 +47,7 @@ import supybot.irclib as irclib
import supybot.ircmsgs as ircmsgs
import supybot.ircutils as ircutils
import supybot.callbacks as callbacks
import supybot.registry as registry
from supybot import commands
from supybot.i18n import PluginInternationalization, internationalizeDocstring
@ -289,6 +290,18 @@ class Misc(callbacks.Plugin):
You may also want to use the 'list' command to list all available
plugins and commands.
"""
if not command:
cHelp = self.registryValue("customHelpString")
if cHelp:
irc.reply(cHelp)
return
try:
renames = conf.supybot.commands.renames.get("Misc")()
if "help" in renames:
ourcmd = conf.supybot.commands.renames.get("Misc").get("help")()
except registry.NonExistentRegistryEntry:
ourcmd = "help"
command = ["misc", ourcmd]
command = list(map(callbacks.canonicalName, command))
(maxL, cbs) = irc.findCallbacksForArgs(command)
if maxL == command:
@ -310,7 +323,7 @@ class Misc(callbacks.Plugin):
'you may be able to find its provided commands '
'using \'list {0}\'.'.format(command[0].title()))
irc.error(s)
help = wrap(help, [many('something')])
help = wrap(help, [any('something')])
@internationalizeDocstring
def version(self, irc, msg, args):