Kaguya v0.6.6 Kaguya

Top level module responsible for starting the bot properly.

Configuration

  • server - Hostname or IP address to connect with. String.
  • server_ip_type - IP version to use. Can be either inet or inet6
  • port - Port to connect on. Integer.
  • bot_name - Name to use by bot. String.
  • channels - List of channels to join. Format: #<name>. List
  • help_cmd - Specifies command to act as help. Defaults to .help. String
  • use_ssl - Specifies whether to use SSL or not. Boolean
  • reconnect_interval - Interval for reconnection in ms. Integer. Not used.
  • server_timeout - Timeout(ms) that determines when server gets disconnected. Integer. When omitted Kaguya does not verifies connectivity with server. It is recommended to set at least few minutes.

Link to this section Summary

Functions

Starts the bot, checking for proper configuration first

Link to this section Functions

Link to this function start(type, args)

Starts the bot, checking for proper configuration first.

Raises exception on incomplete configuration.