]> jfr.im git - erebus/wiki.git/commitdiff
Updated Commands (markdown)
authorJohn <redacted>
Mon, 9 Dec 2019 11:39:03 +0000 (05:39 -0600)
committerJohn <redacted>
Mon, 9 Dec 2019 11:39:03 +0000 (05:39 -0600)
Commands.md

index 2d2d7b2e43ded5ecd87ffff402c6dfc698feb7ac..5565f8c523e6cb9146cbcd4c9316fb1cbfc4da5c 100644 (file)
@@ -1,5 +1,9 @@
 The bot has absolutely no built-in commands. All commands are provided by modules. It is strongly recommended that you load the `control` module, which includes commands to stop the bot, load/unload other modules, etc.
 
+Modules may depend on other modules, or they may have "softdeps" on other modules. Either will cause the bot to attempt to load in that other module. A failure loading a dependency will cause the dependent module to not be loaded. A failure loading a softdep will be ignored.
+
+Modules are loaded by specifying `modulename = 1` in the `[autoloads]` section of bot.config, or by using the `modload` command provided by the `control` module. If the `[autoloads]` section contains `modulename = 0`, attempts to load that module (from any source - modload, dependencies, softdeps) will fail.
+
 * chanops
   * kick - kick user by nick, or all users with a given auth
   * kickall - kick all users with the same auth
@@ -80,7 +84,7 @@ The bot has absolutely no built-in commands. All commands are provided by module
   * settarget - set goal
   * delcat - delete an entire category
 * urls - This module does not provide any commands. Instead, it listens for *all* messages, and will respond to messages which look like a URL with the title of the URL.
-* userinfo - This module is a softdep or hard dependency of some other modules. This means it will be automatically loaded unless you specify `userinfo = 0` in bot.config's `[autoloads]` section. This module maintains a database of 'info items' associated with a nick/auth.
+* userinfo
   * getitems - lists info items known about someone
   * getinfo - gets an info item about someone
   * setinfo - sets an info item about yourself