insobot » Forums » User Guide: Modules and Commands
insofaras
Alex Baines
22 posts
1 project
#12056 User Guide: Modules and Commands
3 months, 3 weeks ago

This is the first in a series of forum posts that documents how to use various
parts of insobot.

Modules
Insobot is split into different modules as you probably know.

To view which modules are enabled in a channel, use \m
1
2
<me>      | \m
<insobot> | Modules for #test: ☐ automod, ☐ haiku, ☐ hmh, ☐ imgmacro, ☑ linkinfo, ☑ markov,[...]

To enable a module, use \mon, and to disable a module use \moff.
1
2
3
4
<me>      | \mon psa
<insobot> | me: Enabled module psa.
<me>      | \moff poll
<insobot> | me: That module is already disabled here!

To view a module's description, use \minfo.
1
2
<me>      | \minfo markov
<insobot> | me: markov: Says incomprehensible stuff

Commands

Most of insobot's built-in commands start with \, this was initially to avoid
clashes with hmh_bot's commands, and now hmd_bot's. For modules that only insobot
uses, like mod_schedule, its commands will probably work with ! too.

Note that Twitch's chat system strips the two character sequences \n and \t,
likely due to lazy programming (not wanting to escape them correctly for their
json backend is my guess). This breaks some commands like \time -- where this
happens the ! version should be available instead.

Any user created commands (aliases via mod_alias) will always begin with !.

To alieviate some of this confusion, you can now private message insobot
'help <command>' to determine the proper syntax. This will also show you
additional information about the command. e.g:

1
2
3
/msg insobot help !q+ -> unknown command (hmd_bot uses the ! version)
/msg insobot help \q+ -> shows info as expected
/msg insobot help q+  -> shows info for \q+

If you use help <module name> instead, then the available commands from that
module will be listed. In the case of a command and module sharing the name
(like alias or info), the module will take precedece. You have to add the \ or !
to get the command help in this case.

The help command also works in channels as usual.

1
2
3
4
<me>      | \help haiku
<insobot> | [module] haiku commands: [ !haiku !scount ]. Use !help <command> for more info.
<me>      | \help !haiku
<insobot> | [mod_haiku cmd]: !haiku | Generates a haiku using text from mod_markov

If you have any more questions about using modules or commands, ask away in this
post!