sibyl.conf.default

################################################################################
#
# Lines starting with "#" or ";" are comments. You can also add in-line comments
# using " ;" after an option.
#
# Options are specified one per line with "opt = value".
#
# If an option isn't recognized, it will be ignored. You can use these as
# custom variables to make some defintions easier. For example:
#
#     users = alice,bob
#     cmds = play,pause
#     bw_list = b %(users)s *; w %(users)s %(cmds)s
#
# Because of the above interpolation, percent signs must be escaped; i.e. use
# "%%" in the config file to mean "%" after parsing.
#
# The value for an option can span multiple lines.
#
# Unknown options will appear as INFO in the log, and invalid values as WARN. If
# something isn't working as expected, check the log for "config" entries.
#
# Relative paths are relative to the location of "run.py"
#
# For full specifications read the python docs on SafeConfigParser:
#     https://docs.python.org/2/library/configparser.html
#
################################################################################

# [REQUIRED] Comma-separated list of protocols to use
protocols = cli

# Chat rooms to join on bot startup
# Format for single entry: proto:room,nick,pass
# Can also be: proto:room OR proto:room,nick OR proto:room,,pass
# Multiple rooms separated by ";" e.g.: proto:room,nick,pass; proto:room,nick
#rooms =

# Default nick to use in rooms
#nick_name = Sibyl

# Character sequence used to give the bot a command in a MUC. Default is None.
# Example: "!hello" instead of "Sibyl hello"
#cmd_prefix =

# Black and white list to allow/forbid users from running certain commands
# Format is: w * *; b from id; w from1,from2 id1,id2
# from fields can be protocols, rooms, or usernames
#   protocols must be p:proto e.g. "p:xmpp"
#   rooms must be r:protocol:room e.g. "r:xmpp:room@conference.server.com"
#   users must be u:protocol:user e.g. "u:xmpp:user@server.com"
# id fields can be plugin or chat command names
#   plugins must end with .py e.g. "xbmc.py"
#   commands are anything not matching the above e.g. "stream"
# more details: https://github.com/TheSchwa/sibyl/wiki/BW-List
#bw_list = w * *

# Enable dangerous commands (e.g. die, reboot, config)
#chat_ctrl = False

# Enable/Disable plugins (you should only use one of the below not both)
# To use all plugins but a few, use the "disable" option
# To only use a list of specified plugins, use the "enable" option
#disable =
#enable = bookmark,general,library,note,room,xbmc

# Rename chat commands; duplicates are not allowed; format:
#   hello:goodbye, audio:music, ...
# Note that if "goodbye" already exists and you don't rename it, it will be lost
#rename =

# If True, upon joining a room during bot startup, send a message listing errors
#tell_errors = True

# If not set, tell_errors in all rooms; else only tell in specified rooms,
# format is the same as for "rooms" config opt above
#tell_rooms =

# Only tell errors with at least this log level
# can be: critical, error, warning, info, debug
#tell_level = warning

################################################################################
# Email options
################################################################################

# Account login
#email.username =
#email.password =

# If set, only e-mails containing this string will be executed
#email.key =

# Delete messages after receiving them
#email.delete = True

# By default, these options use the part after "@" in email.address
# as their server and prepend either "imap" or "smtp"
#email.imap =
#email.smtp =

################################################################################
# Socket options
################################################################################

# Default port (note that on linux only root can use ports below 1024)
#socket.port = 8767

# If specified, clients must enter this password when connecting
#socket.password =

# If pubkey & privkey are set, connections will be created using SSL
# the first two are file paths; the last is used if the private key is encrypted
#socket.pubkey =
#socket.privkey =
#socket.key_password =

# If True, listen for connections from the internet instead of just localhost
#socket.internet = False

# Log raw message contents
# WARNING: passwords sent over socket will be logged
#socket.debug = False

################################################################################
# XMPP options
################################################################################

# Login info
#xmpp.username =
#xmpp.password =

# XMPP resource; default is the class name of the bot.
#xmpp.resource = SibylBot

# Server to connect to if different than in the JID given in "username"
#xmpp.server =

# Port to connect to the XMPP server.
#xmpp.port = 5222

# Only accept subscriptions from the specified domain; can be either "True" to
# use the domain specified by "username", a string specifying a domain, or
# "False" to accept all subscribe requests.
#xmpp.priv_domain = True

# Interval (seconds) to ping the server to check for disconnect. 0 means never
#xmpp.ping_freq = 60

# Timeout for pings. Only matters if "ping_freq" is greater than 0
#xmpp.ping_timeout = 3

# Print XMPPPY stanza debug info to the terminal
#xmpp.debug = False

################################################################################
# Matrix options
################################################################################

# username, password, homeserver
#matrix.username =
#matrix.password =
#matrix.server =

# Optional: log full Matrix events at DEBUG level
#matrix.debug = False

# Optional: Join rooms on invite
# "accept" to accept all invites, "reject" to ignore all invites,
# "domain" to only accept invites from users on the same HS
#matrix.join_on_invite = reject

################################################################################
# Plugin options
################################################################################

# File in which to store bookmarks; format is tab-delineated text file
#bookmark.file = data/bookmarks.txt

# When resuming a playlist, whether to always start with the next item rather
# than the bookmarked file itself
#bookmark.resume_next = False

# Max stack depth when executing aliases
#general.alias_depth = 10

# File for storing aliases
#general.alias_file = data/aliases.txt

# Use degrees instead of radians for trig functions in the calc cmd
#general.calc_degrees = True

# Display results from calc cmd in scientific notation
#general.calc_scientific = False

# If True, allow the use of the config chat command in rooms
#general.config_rooms = True

# Default number of lines to report in the log command
#general.log_lines = 10

# If True, include timestamps in log command responses
#general.log_time = True

# File in which to store library contents; format is python pickle
#library.file = data/library.pickle

# Maximum number of matches to reply with in chat when searching the library.
# A value of 0 means no limit. Note that some servers will kick the bot for
# sending very long replies.
#library.max_matches = 10

# Directories to search for audio and video files to add to the library.
# Format for regular directories: /path/to/dir1; /path/to/dir2
# Format for samba shares: server1,share1; server2,share2,username,password
# https://github.com/TheSchwa/sibyl/wiki/Library#specifying-library-search-paths
#library.audio_dirs =
#library.video_dirs =

# Translations for library paths if running Sibyl on a different box than Kodi
# Format: localpath1, remotepath1; localpath2, remotepath2
# https://github.com/TheSchwa/sibyl/wiki/Library#remote-kodi-instance
#library.remote =

# File in which to store notes; format is tab-delineated text file
#note.file = data/notes.txt

# Whether to respond to links with the page title
#room.link_echo = False

# Allow room chat commands to interact across protocols
# e.g. this allows you to join an XMPP room from the CLI
#room.cross_proto = True

# File in which to store triggers; format is tab-delineated text file
#room.trigger_file = data/triggers.txt

# Bridge rooms (i.e. bot echoes all messages between them)
# Format is: proto1:room1,proto2:room2; proto3:room3,proto4:room4
# Each bridge is separated by a semi-colon
# Within each bridge, rooms are separated by commas
# A room can only be in a single bridge
# Only rooms listed in the config option "rooms" can be used in bridges
#room.bridges =

# Allow unicode characters in user names when bridging
#room.unicode_users = True

# Get occupants from bridged rooms when broadcasting messages to all users
#room.bridge_broadcast = True

# IP address where the XBMC/Kodi/OSMC/etc. web interface is running
# Format is IP:PORT or just IP (port defaults to 80 if not specified)
# The default assumes XBMC is running on the same host as Sibyl
#xbmc.ip = 127.0.0.1:8080

# Username and password to use to access the web interface; default is None
#xbmc.username =
#xbmc.password =

# Default timeout for JSON requests (non-negative int)
# NOTE: audios & videos commands always use 60 to accommodate huge playlists
#xbmc.timeout = 15

################################################################################
# Logging options
################################################################################

# Log level can be: critical, error, warning, info, debug
#log_level = info

# File used for logging
#log_file = data/sibyl.log

# Log messages from other python modules
#log_requests = False
#log_urllib3 = False

# If False overwrite the log file on bot init, if True append to the log file
#log_append = True

# If True log a debug message every time a hook is run (excluding idle hooks)
#log_hooks = False

################################################################################
# Advanced options
################################################################################

# Directory to search for plugins; note the default uses relative paths
#cmd_dir = cmds

# Action to take when a chat command encounters an error
# If False, return a generic error msg; if True, return the exception name
#except_reply = True

# Require commands in a chat room to start with nick_name or cmd_prefix
#only_direct = True

# Minimum number of seconds to wait before trying to reconnect (increases exponentially)
#recon_min = 30

# Maximum number of seconds to wait before trying to reconnect
#recon_max = 300

# Messages to remember when a protocol disconnects and resend when reconnects
# or we get kicked from a room for whatever reason then rejoin
# positive is limit, 0 disables deferring, negative is infinite
#defer_total = 100
#defer_proto = 100
#defer_room = 10
#defer_priv = 10

# Whether to include the name of plugins in the "help" list
#help_plugin = False

# Catch ALL exceptions and log them without killing the bot. Should only be set
# to "False" for debugging purposes.
#catch_except = True

# If true, save/load state for plugins requesting variable persistence
#persistence = True

# File in which to save persistent variables
#state_file = data/state.pickle

# If True, kill stdout to disable libraries from printing to the console
# NOTE: the cli protocol will work regardless of this setting
#kill_stdout = True

# Ignore bw_list and allow every command for these protocols (comma-separated)
#admin_protos = cli

# How often to run @botidle hooks (exact timing not guaranteed)
#idle_freq = 1

# When to warn about @botidle hooks taking too long (non-negative float)
#idle_time = 0.1

# Number of consecutive warnings to delete a @botidle hook (non-negative int)
# Setting this to 0 disables (not deletes) all @botidle hooks
#idle_count = 5