X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/fb20be7c5c80f13474786337d69005f3497d21c6..b4e3e62e5e48277e34e40da4f9b79b4291fabce3:/modules/foo.py

diff --git a/modules/foo.py b/modules/foo.py
index 526fdff..bb56be0 100644
--- a/modules/foo.py
+++ b/modules/foo.py
@@ -6,9 +6,15 @@
 modinfo = {
 	'author': 'Erebus Team',
 	'license': 'public domain',
-	'compatible': [1], # compatible module API versions
+	'compatible': [1,2], # compatible module API versions
 	'depends': [], # other modules required to work properly?
+	'softdeps': ['help'], # modules which are preferred but not required
 }
+# note: softdeps will be loaded before this module, IF not disabled in the configuration (autoload.module = 0) (and if it exists)
+# however, if it is disabled it will be silently ignored, and if it is unloaded at runtime it won't cause this one to unload.
+#
+# basically, softdeps are things this module will use if available, but does not require (no errors will occur if it's not loaded)
+# for example, @lib.help() will attempt to use the help module, but swallow errors if it is not loaded
 
 # preamble
 import modlib
@@ -26,6 +32,11 @@ def test(bot, user, chan, realtarget, *args):
 	bot.msg(replyto, "You said: %s" % (' '.join([str(arg) for arg in args])))
 
 @lib.hook(('foo', 'bar'), needchan=False) #hooks !foo and !bar as aliases
-@lib.help(None, 'replies with nonsense.', cmd=('foo', 'bar'))
+@lib.help(None, 'replies with nonsense.', "it's a very non-sensical command", "more lines")
 def foobar(bot, user, chan, realtarget, *args):
 	bot.msg(user, "Foo bar baz.")
+
+@lib.hook()
+@lib.help(None, 'a command that does nothing but requires you specify a channel')
+def needchan(bot, user, chan, realtarget, *args):
+	bot.msg(user, "You did it!")