Commands.md

   1 The bot has absolutely no built-in commands. All commands are provided by modules.
   2 It is strongly recommended that you load the `control` module,
   3 which includes commands to stop the bot, load/unload other modules, etc.
   4
   5 Modules may depend on other modules, or they may have "softdeps" on other modules.
   6 Either will cause the bot to attempt to load in that other module.
   7 A failure loading a dependency will cause the module which depends on it to not be loaded.
   8 A failure loading a softdep will be ignored.
   9
  10 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.
  11 If the `[autoloads]` section contains `modulename = 0`, attempts to load that module as a dependency or softdep will fail.
  12 Loading it directly (i.e. with the `modload` command) will still succeed.
  13
  14 * chanops
  15   * kick - kick user by nick, or all users with a given auth
  16   * kickall - kick all users with the same auth
  17   * kickeach - kick multiple users
  18   * op
  19   * deop
  20   * voice
  21   * devoice
  22 * control
  23   * die - stop the bot
  24   * modload - load a module
  25   * modunload - unload a module
  26   * modreload - reload a module
  27   * modlist - list loaded modules
  28   * whois - determine what auth the bot thinks someone is using, and their access level
  29   * whoami - whois on yourself
  30   * auth - ask the bot to re-check what your auth is
  31   * qstat - display length of each message queue
  32   * qclear - clear message queues
  33   * inject - inject a line as though it came from another user
  34 * eval - **experimental**: This module is meant solely as a development aid. It is not recommended for regular use.
  35   * eval
  36   * exec
  37   * exception - raise an exception (meant to test exception handling)
  38 * foo - **sample**: This module does not provide any useful functionality, but is meant as a sample for module developers.
  39   * test
  40   * foo
  41   * needchan
  42   * wantchan
  43 * help - This module is a softdep of most other modules. This means it will be automatically loaded unless you specify `help = 0` in bot.config's `[autoloads]` section.
  44   * genhelp - write help out to files
  45   * showcommands - provide web link to help, from bot.config's `[help] url` setting. If this is not set it will use the bot's public IP address to auto-generate a link.
  46   * help - show help for a given command. If bot.config's `[erebus] nofakelag` setting is truthy, it will also provide a command list if no argument is given.
  47 * misc
  48   * reduce - reduce a fraction
  49 * msg
  50   * msg - send a message. If the target is a channel, this will use PRIVMSG, otherwise it will use NOTICE
  51   * pmsg - send a PRIVMSG
  52 * resources
  53   * ram - report Python's RAM usage
  54   * resources - report Python's resource usage
  55 * sms **unmaintained**: Unfortunately, Twilio decided to obsolete & remove what was previously a recommended part of their SDK within a year. This module will no longer work with current versions of the SDK.
  56   * sms - send SMS using Twilio.
  57 * stafflist
  58   * stafflist - lists bot staff
  59 * subtext: This module does not provide any commands. Instead, it listens for *all* messages, and will respond to messages which look like `s/foo/bar/` and perform a regex replacement on the previous line sent to a channel.
  60 * trivia
  61   * badq - report a bad question
  62   * listcats - list trivia categories
  63   * points
  64   * rank
  65   * showcat - show current category
  66   * start
  67   * stop
  68   * top10
  69   * vote - vote for a goal option
  70   * findq - find an exact match for a question
  71   * findqre - find a partial/regex match for a question
  72   * save - save database to disk
  73   * setcat - change current category
  74   * setnextid - set next question to one in the database
  75   * setnext - set next question
  76   * skip - skip current question
  77   * addcat - create a new category
  78   * addq - create a new question
  79   * badqs - show badq reports
  80   * delq - delete a question
  81   * give - give (or take, with a negative) points
  82   * showq - show question and answer given a question ID
  83   * hintnum - set max number of hints
  84   * hinttimer - set time between hints
  85   * maxmissed - set max missed questions before game auto-stops
  86   * questionpause - set pause between questions
  87   * settarget - set goal
  88   * delcat - delete an entire category
  89 * 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.
  90 * userinfo
  91   * getitems - lists info items known about someone
  92   * getinfo - gets an info item about someone
  93   * setinfo - sets an info item about yourself
  94   * delinfo - deletes an info item about yourself
  95   * osetinfo - sets an info item about someone
  96   * odelinfo - deletes an info item about someone