Usage¶

Use the onebot command to run stuff.

Configuration¶

You can use this sample configuration file:

[bot]
nick=OneBotTest
username=TwoBot
host=my.irc.network

port=6697
ssl=true
# uncomment this if you don't want to check the certificate
# ssl_verify = CERT_NONE

includes=
  irc3.plugins.uptime
  onebot.plugins.acl
  onebot.plugins.lastfm
  onebot.plugins.trakt
  onebot.plugins.botui
  onebot.plugins.whatcd
  irc3.plugins.autojoins
  onebot.plugins.urlinfo
# add your plugins here

autojoins=
  ${hash}channel

# see http://irc3.readthedocs.io/en/latest/plugins/storage.html#module-irc3.plugins.storage
#storage = unix:///var/run/redis/redis.sock?db=10
storage = shelve:///tmp/test.shelf

# Plugin settings are noted as follows
[irc3.plugins.command]
cmd = .
guard=onebot.plugins.acl.user_based_policy

[onebot.plugins.users]
identify_by = mask

[onebot.plugins.acl]
# Pre-seed acl
superadmin=me@my.awesome.host

[onebot.plugins.lastfm]
api_key = myapikey
api_secret = myapikey

[onebot.plugins.trakt]
client_id = myclientid

Most options should mostly speak for themselves. Note that the plugin settings are (obviously) plugin-dependant. You should consult the manual for each plugin to figure out what you need to set.

This project is based on irc3. irc3 plugins are compatible with OneBot. Some OneBot plugins make use of irc3 modules. See the module onebot.plugin. You should consult the irc3 documentation for information about irc3 plugins.

onebot.run(argv=None)[source]

Run OneBot from a config file

Usage: onebot [options] <config>…

Options:

--logdir DIRECTORY  Log directory to use instead of stderr
--logdate           Show datetimes in console output
-r,--raw            Show raw IRC log on the console
-v,--verbose        Increase verbosity
-d,--debug          Add debug commands/utils