]> jfr.im git - erebus/wiki.git/commitdiff
Created Commands (markdown)
authorJohn <redacted>
Mon, 9 Dec 2019 11:34:08 +0000 (05:34 -0600)
committerJohn <redacted>
Mon, 9 Dec 2019 11:34:08 +0000 (05:34 -0600)
Commands.md [new file with mode: 0644]

diff --git a/Commands.md b/Commands.md
new file mode 100644 (file)
index 0000000..2d2d7b2
--- /dev/null
@@ -0,0 +1,89 @@
+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.
+
+* chanops
+  * kick - kick user by nick, or all users with a given auth
+  * kickall - kick all users with the same auth
+  * kickeach - kick multiple users
+  * op
+  * deop
+  * voice
+  * devoice
+* coins - **unmaintained**: This module has not been maintained or tested in quite some time.
+  * btc
+  * doge
+  * ltc
+* control
+  * die - stop the bot
+  * modload - load a module
+  * modunload - unload a module
+  * modreload - reload a module
+  * modlist - list loaded modules
+  * whois - determine what auth the bot thinks someone is using, and their access level
+  * whoami - whois on yourself
+  * auth - ask the bot to re-check what your auth is
+  * qstat - display length of each message queue
+  * qclear - clear message queues
+  * inject - inject a line as though it came from another user
+* eval - **experimental**: This module is meant solely as a development aid. It is not recommended for regular use.
+  * eval
+  * exec
+  * exception - raise an exception (meant to test exception handling)
+* foo - **sample**: This module does not provide any useful functionality, but is meant as a sample for module developers.
+  * test
+  * foo
+  * needchan
+  * wantchan
+* 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.
+  * genhelp - write help out to files
+  * 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.
+  * 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.
+* misc
+  * reduce - reduce a fraction
+* msg
+  * msg - send a message. If the target is a channel, this will use PRIVMSG, otherwise it will use NOTICE
+  * pmsg - send a PRIVMSG
+* resources
+  * ram - report Python's RAM usage
+  * resources - report Python's resource usage
+* 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.
+  * sms - send SMS using Twilio.
+* stafflist
+  * stafflist - lists bot staff
+* 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.
+* trivia
+  * badq - report a bad question
+  * listcats - list trivia categories
+  * points
+  * rank
+  * showcat - show current category
+  * start
+  * stop
+  * top10
+  * vote - vote for a goal option
+  * findq - find an exact match for a question
+  * findqre - find a partial/regex match for a question
+  * save - save database to disk
+  * setcat - change current category
+  * setnextid - set next question to one in the database
+  * setnext - set next question
+  * skip - skip current question
+  * addcat - create a new category
+  * addq - create a new question
+  * badqs - show badq reports
+  * delq - delete a question
+  * give - give (or take, with a negative) points
+  * showq - show question and answer given a question ID
+  * hintnum - set max number of hints
+  * hinttimer - set time between hints
+  * maxmissed - set max missed questions before game auto-stops
+  * questionpause - set pause between questions
+  * 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.
+  * getitems - lists info items known about someone
+  * getinfo - gets an info item about someone
+  * setinfo - sets an info item about yourself
+  * delinfo - deletes an info item about yourself
+  * osetinfo - sets an info item about someone
+  * odelinfo - deletes an info item about someone
\ No newline at end of file